@itentialopensource/adapter-digicert_pki 0.1.1 → 1.1.0

package/entities/CertificateProfiles/mockdatafiles/listCertificateProfiles-default.json

@@ -0,0 +1,219 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "pagination": true,
+  "next": false,
+  "total": 1,
+  "records": [
+    {
+      "id": "1fb93940-7580-4f94-a8ca-57585f9ecb2e",
+      "name": "Certificate profile example",
+      "account_id": "5220789d-df09-485f-aa21-d2979188b3ca",
+      "certificate_template": {
+        "id": "c376def4-b39a-4301-8391-6ffecd071057",
+        "name": "Certificate template example"
+      },
+      "allow_bare_public_key": false,
+      "created_at": "2022-07-06T08:22:25Z",
+      "status": "ACTIVE",
+      "body": [
+        {
+          "key": "certificate_value",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "auto",
+          "enabled": true
+        },
+        {
+          "key": "unique_certificate_value",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "no",
+          "enabled": true
+        },
+        {
+          "key": "signature_algorithm",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "match_issuer",
+          "enabled": true
+        },
+        {
+          "key": "allow_any_key_type",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "yes",
+          "enabled": true
+        },
+        {
+          "key": "allowed_key_types",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "[\"rsa_2048\",\"rsa_3072\",\"rsa_4096\",\"p_256\",\"p_384\",\"p_521\",\"ed_25519\"]",
+          "enabled": true
+        },
+        {
+          "key": "subject.common_name",
+          "optional": false,
+          "sources": [
+            "user_supplied",
+            "csr"
+          ],
+          "enabled": true
+        },
+        {
+          "key": "subject.organization_name",
+          "optional": true,
+          "sources": [
+            "user_supplied",
+            "csr"
+          ],
+          "enabled": true
+        },
+        {
+          "key": "subject.organization_unit",
+          "optional": true,
+          "sources": [],
+          "enabled": false
+        },
+        {
+          "key": "subject.street_address",
+          "optional": true,
+          "sources": [],
+          "enabled": false
+        },
+        {
+          "key": "subject.postal_code",
+          "optional": true,
+          "sources": [],
+          "enabled": false
+        },
+        {
+          "key": "subject.locality",
+          "optional": true,
+          "sources": [],
+          "enabled": false
+        },
+        {
+          "key": "subject.state",
+          "optional": true,
+          "sources": [],
+          "enabled": false
+        },
+        {
+          "key": "subject.country",
+          "optional": true,
+          "sources": [],
+          "enabled": false
+        },
+        {
+          "key": "subject.unique_identifier",
+          "optional": true,
+          "sources": [
+            "user_supplied",
+            "csr"
+          ],
+          "enabled": true
+        },
+        {
+          "key": "validity.duration_unit",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "months",
+          "enabled": true
+        },
+        {
+          "key": "validity.duration_value",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "9",
+          "enabled": true
+        },
+        {
+          "key": "key_usage.critical",
+          "optional": true,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "yes",
+          "enabled": false
+        },
+        {
+          "key": "extended_key_usage.critical",
+          "optional": true,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "yes",
+          "enabled": false
+        },
+        {
+          "key": "extended_key_usage.additional_values",
+          "optional": true,
+          "sources": [],
+          "enabled": false
+        },
+        {
+          "key": "renewal_settings.renew_valid_cert",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "anytime",
+          "enabled": true
+        },
+        {
+          "key": "renewal_settings.renew_expired_cert",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "anytime",
+          "enabled": true
+        },
+        {
+          "key": "renewal_settings.renew_revoked_cert",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "true",
+          "enabled": true
+        },
+        {
+          "key": "renewal_settings.renewal_key_pair",
+          "optional": false,
+          "sources": [
+            "fixed_value"
+          ],
+          "value": "optional",
+          "enabled": true
+        }
+      ],
+      "enrollment_methods": [],
+      "certificate_format": "x509",
+      "certificate_type": "end_entity",
+      "ca_connector_type": "digicert_one",
+      "divisions": [
+        {
+          "id": "4340c299-f39c-4fcf-8d3a-650d24e5eb99",
+          "name": "Example division"
+        }
+      ]
+    }
+  ]
+}

package/entities/CertificateProfiles/schema.json

@@ -0,0 +1,116 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "listCertificateProfiles",
+        "createCertificateProfile",
+        "getCertificateProfile",
+        "updateCertificateProfile",
+        "disableCertificateProfile",
+        "enableCertificateProfile",
+        "deleteCertificateProfile",
+        "restoreCertificateProfile",
+        "assignCertificateProfileDivisions",
+        "unassignCertificateProfileDivisions"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to certificate profiles assigned to an account ID that is an exact match for the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "account_id"
+    },    
+    "divisionId": {
+      "type": "string",
+      "description": "Limits results to certificate profiles assigned to a division ID that is an exact match for the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "templateName": {
+      "type": "string",
+      "description": "Limits results to certificate profiles that use the given certificate template.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "template_name"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits results to certificate profiles created after the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_from"
+    },    
+    "createdTo": {
+      "type": "string",
+      "description": "Limits results to certificate profiles created before the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_to"
+    },    
+    "sortBy": {
+      "type": "string",
+      "description": "Sorts results by the given property. Case-insensitive. Default `sort_by` property is `created_at`.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_by"
+    },    
+    "sortDirection": {
+      "type": "",
+      "description": "Sorts results in ascending or descending order by the value of the `sort_by` property. Case-insensitive. Default `sort_direction` value is `DESC`.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_direction"
+    },    
+    "certificateProfileId": {
+      "type": "string",
+      "description": "Certificate profile ID (UUID).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_profile_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/CertificateRequests/action.json

@@ -0,0 +1,25 @@
+{
+  "actions": [
+    {
+      "name": "getRequestStatus",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-request/{pathv1}/status?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getRequestStatus-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/CertificateRequests/mockdatafiles/getRequestStatus-default.json

@@ -0,0 +1,5 @@
+{
+  "certificate_request_id": "cad89ac2-fe65-4b11-bf28-3b84a9c59bdd",
+  "status": "PENDING_APPROVAL",
+  "certificate_id": "51967282-23d3-429b-b4c6-a52e2c2dd389"
+}

package/entities/CertificateRequests/schema.json

@@ -0,0 +1,30 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "getRequestStatus"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "certificateRequestId": {
+      "type": "string",
+      "description": "Certificate request ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_request_id"
+    } 
+  },
+  "definitions": {}
+}

package/entities/CertificateTemplates/action.json

@@ -0,0 +1,186 @@
+{
+  "actions": [
+    {
+      "name": "listCertificateTemplates",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "createCertificateTemplate",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getCertificateTemplate",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "updateCertificateTemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "clonecertificatetemplate",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template/{pathv1}/clone?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "disableCertificateTemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template/{pathv1}/disable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "enableCertificateTemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template/{pathv1}/enable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteCertificateTemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template/{pathv1}/delete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "restoreCertificateTemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-template/{pathv1}/undelete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/CertificateTemplates/schema.json

@@ -0,0 +1,104 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "listCertificateTemplates",
+        "createCertificateTemplate",
+        "getCertificateTemplate",
+        "updateCertificateTemplate",
+        "clonecertificatetemplate",
+        "disableCertificateTemplate",
+        "enableCertificateTemplate",
+        "deleteCertificateTemplate",
+        "restoreCertificateTemplate"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to certificate templates assigned to an account ID that is an exact match for the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "account_id"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits results to certificate templates created after the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_from"
+    },    
+    "createdTo": {
+      "type": "string",
+      "description": "Limits results to certificate templates created before the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_to"
+    },    
+    "limitByAccount": {
+      "type": "boolean",
+      "description": "Limits results to certificate templates that are either limited to specific accounts (true) or not limited (false).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "limit_by_account"
+    },    
+    "sortBy": {
+      "type": "",
+      "description": "Sorts results by the given property. Case-insensitive. Default `sort_by` property is `created_at`.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_by"
+    },    
+    "sortDirection": {
+      "type": "",
+      "description": "Sorts results in ascending or descending order by the value of the `sort_by` property. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_direction"
+    },    
+    "certificateTemplateId": {
+      "type": "string",
+      "description": "Certificate template ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_template_id"
+    }
+  },
+  "definitions": {}
+}