@itentialopensource/adapter-digicert_pki 0.1.1 → 1.0.0

package/entities/AuthenticationCertificates/mockdatafiles/getAuthenticationCertificateDetails-default.json

@@ -0,0 +1,49 @@
+{
+  "template_id": "<template_id>",
+  "id": "<authentication_certificate_id>",
+  "name": "Example Name",
+  "enrollment_profile": {
+    "id": "<enrollment_profile_id>",
+    "name": "<enrollment_profile_name>"
+  },
+  "start_date": "2021-05-20T00:00:00Z",
+  "end_date": "2022-05-20T00:00:00Z",
+  "usage_limit": "0",
+  "registered_values": [
+    {
+      "certificate_field": "subject.common_name",
+      "matcher": "equals",
+      "value": "common name",
+      "multiple": false
+    },
+    {
+      "certificate_field": "subject.organization_unit",
+      "matcher": "equals",
+      "value": [
+        "Unit 1",
+        "Unit 2"
+      ],
+      "multiple": true
+    }
+  ],
+  "number_of_usage": "0",
+  "status": "ACTIVE",
+  "created_at": "2021-05-13T21:05:43.273689Z",
+  "certificate_issuer_common_name": "Issuing CA Name",
+  "use_passcode": false,
+  "generation_option": "string",
+  "passcode": "ExamplePasscode123",
+  "passcode_length": 20,
+  "certificate": {
+    "id": "<certificate_id>",
+    "name": "Certificate Name"
+  },
+  "pem": "<pem>",
+  "certificate_expires_on": "2022-04-30T17:38:58Z",
+  "certificate_serial_number": "<certificate_serial_number>",
+  "certificate_status": "ISSUED",
+  "certificate_thumbprint": "<certificate_thumbprint>",
+  "certificate_organization": "Example Organization",
+  "certificate_organization_units": [],
+  "certificate_attributes": []
+}

package/entities/AuthenticationCertificates/mockdatafiles/listAuthenticationCertificates-default.json

@@ -0,0 +1,93 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "pagination": true,
+  "next": false,
+  "total": 1,
+  "records": [
+    {
+      "start_date": "2021-05-20T00:00:00Z",
+      "end_date": "2022-05-20T00:00:00Z",
+      "registered_values": [
+        {
+          "certificate_field": "subject.common_name",
+          "matcher": "equals",
+          "value": "common name",
+          "multiple": false
+        },
+        {
+          "certificate_field": "subject.organization_unit",
+          "matcher": "equals",
+          "value": [
+            "Unit 1",
+            "Unit 2"
+          ],
+          "multiple": true
+        }
+      ],
+      "id": "<authentication_certificate_id>",
+      "certificate": {
+        "id": "<certificate_id>",
+        "name": "Certificate Name"
+      },
+      "enrollment_profile": {
+        "id": "<enrollment_profile_id>",
+        "name": "<enrollment_profile_name>"
+      },
+      "number_of_usage": "0",
+      "status": "ACTIVE",
+      "created_at": "2021-05-13T21:05:43.273689Z",
+      "pem": "<pem>",
+      "certificate_expires_on": "2022-04-30T17:38:58Z",
+      "certificate_serial_number": "<certificate_serial_number>",
+      "certificate_issuer_common_name": "Issuing CA Name",
+      "certificate_status": "ISSUED",
+      "certificate_thumbprint": "<certificate_thumbprint>",
+      "certificate_organization": "Example Organization",
+      "certificate_organization_units": [],
+      "certificate_attributes": [],
+      "template_id": "<template_id>",
+      "use_passcode": false
+    },
+    {
+      "start_date": "2021-05-20T00:00:00Z",
+      "end_date": "2022-05-20T00:00:00Z",
+      "registered_values": [
+        {
+          "certificate_field": "subject.common_name",
+          "matcher": "equals",
+          "value": "common name",
+          "multiple": false
+        },
+        {
+          "certificate_field": "subject.organization_unit",
+          "matcher": "equals",
+          "value": [
+            "Unit 1",
+            "Unit 2"
+          ],
+          "multiple": true
+        }
+      ],
+      "id": "<authentication_certificate_id>",
+      "certificate": {},
+      "enrollment_profile": {
+        "id": "<enrollment_profile_id>",
+        "name": "<enrollment_profile_name>"
+      },
+      "number_of_usage": "0",
+      "status": "ACTIVE",
+      "created_at": "2021-05-13T21:05:43.273689Z",
+      "certificate_issuer_common_name": "Issuing CA Name",
+      "certificate_attributes": [
+        {
+          "certificate_attribute": "subject.common_name",
+          "value": "common name",
+          "multiple": false
+        }
+      ],
+      "template_id": "<template_id>",
+      "use_passcode": false
+    }
+  ]
+}

package/entities/AuthenticationCertificates/mockdatafiles/updateAuthenticationCertificate-default.json

@@ -0,0 +1,48 @@
+{
+  "template_id": "<template_id>",
+  "id": "<authentication_certificate_id>",
+  "name": "Example Name",
+  "enrollment_profile": {
+    "id": "<enrollment_profile_id>",
+    "name": "<enrollment_profile_name>"
+  },
+  "start_date": "2021-05-20T00:00:00Z",
+  "end_date": "2022-05-20T00:00:00Z",
+  "usage_limit": "0",
+  "registered_values": [
+    {
+      "certificate_field": "subject.common_name",
+      "matcher": "equals",
+      "value": "common name",
+      "multiple": false
+    },
+    {
+      "certificate_field": "subject.organization_unit",
+      "matcher": "equals",
+      "value": [
+        "Unit 1",
+        "Unit 2"
+      ],
+      "multiple": true
+    }
+  ],
+  "number_of_usage": "0",
+  "status": "ACTIVE",
+  "created_at": "2021-05-13T21:05:43.273689Z",
+  "certificate_issuer_common_name": "Issuing CA Name",
+  "use_passcode": false,
+  "generation_option": "string",
+  "passcode": "ExamplePasscode123",
+  "passcode_length": 20,
+  "certificate": {
+    "id": "<certificate_id>",
+    "name": "Certificate Name"
+  },
+  "pem": "<pem>",
+  "certificate_expires_on": "2022-04-30T17:38:58Z",
+  "certificate_serial_number": "<certificate_serial_number>",
+  "certificate_status": "ISSUED",
+  "certificate_thumbprint": "<certificate_thumbprint>",
+  "certificate_organization": "Example Organization",
+  "certificate_organization_units": []
+}

package/entities/AuthenticationCertificates/schema.json

@@ -0,0 +1,202 @@
+{
+  "$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": [
+        "addAuthenticationCertificate",
+        "listAuthenticationCertificates",
+        "getAuthenticationCertificateDetails",
+        "updateAuthenticationCertificate",
+        "disableAuthenticationCertificate",
+        "enableAuthenticationCertificate",
+        "deleteAuthenticationCertificate",
+        "restoreAuthenticationCertificate"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to authentication certificates for the account with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "account_id"
+    },    
+    "divisionId": {
+      "type": "string",
+      "description": "Limits results to authentication certificates for the division with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "authenticationCaCommonName": {
+      "type": "string",
+      "description": "Limits results to authentication certificates associated with authentication CA certificates that have a common name value containing the given string. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_ca_common_name"
+    },    
+    "templateId": {
+      "type": "string",
+      "description": "Limits results to authentication certificates created from the authentication CA template with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "template_id"
+    },    
+    "authenticationCaId": {
+      "type": "string",
+      "description": "Limits results to authentication certificates associated with the authentication CA certificate with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_ca_id"
+    },    
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Limits results to authentication certificates assigned to the enrollment profile with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_id"
+    },    
+    "enrollmentProfileName": {
+      "type": "string",
+      "description": "Limits results to authentication certificates assigned to enrollment profiles with a name that contains the given string. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_name"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits results to authentication certificates 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 authentication certificates created before the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_to"
+    },    
+    "usageLimitFrom": {
+      "type": "number",
+      "description": "Limits results to authentication certificates with a usage limit higher than the given number. Inclusive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "usage_limit_from"
+    },    
+    "usageLimitTo": {
+      "type": "number",
+      "description": "Limits results to authentication certificates with a usage limit lower than the given number. Inclusive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "usage_limit_to"
+    },    
+    "expiresFrom": {
+      "type": "string",
+      "description": "Limits results to authentication certificates that expire after the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "expires_from"
+    },    
+    "expiresTo": {
+      "type": "string",
+      "description": "Limits results to authentication certificates that expire before the given date  Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "expires_to"
+    },    
+    "sortBy": {
+      "type": "",
+      "description": "Sorts results by the given property. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_by"
+    },    
+    "sortDirection": {
+      "type": "",
+      "description": "Sorts results in ascending (`ASC`) or descending (`DESC`) order by the value of the `sort_by` property. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_direction"
+    },    
+    "authenticationCertificateId": {
+      "type": "string",
+      "description": "ID of the authentication certificate.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_certificate_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/BatchCertificateEnrollment/action.json

@@ -0,0 +1,268 @@
+{
+  "actions": [
+    {
+      "name": "batchCSREnroll",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "FORM",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/batchCSREnroll-default.json"
+        }
+      ]
+    },
+    {
+      "name": "batchEnrollWithKeyGen",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll-key-gen?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "FORM",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/batchEnrollWithKeyGen-default.json"
+        }
+      ]
+    },
+    {
+      "name": "batchEnrollWithKeyGenMac",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/batch-enroll-key-gen-mac?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "FORM",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/batchEnrollWithKeyGenMac-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listBatchJobs",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getBatchJobSettings",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getBatchJobSettings-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateBatchJobSettings",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateBatchJobSettings-default.json"
+        }
+      ]
+    },
+    {
+      "name": "regenerateBatchJobPasscode",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/regenerate-passcode?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/regenerateBatchJobPasscode-default.json"
+        }
+      ]
+    },
+    {
+      "name": "approveJob",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/approve?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "rejectJob",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/reject?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "downloadReport",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-report?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "downloadCertificates",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-certificates?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/downloadCertificates-default.json"
+        }
+      ]
+    },
+    {
+      "name": "deleteDownloadUrls",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/delete-download-urls?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "resendDownloadUrls",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/resend-download-urls?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/BatchCertificateEnrollment/mockdatafiles/batchCSREnroll-default.json

@@ -0,0 +1,22 @@
+{
+  "id": "da342f63-dead-4bae-a065-eb8822948148",
+  "name": "Example batch job",
+  "status": null,
+  "total_items": 10,
+  "failed_items": 6,
+  "processing_time": 900,
+  "job_type": null,
+  "passcode": "string",
+  "passcode_generation_option": null,
+  "description": "Example description.",
+  "certificate_format": null,
+  "emails": [
+    "bob@example.com",
+    "alice@example.com"
+  ],
+  "external_emails": [
+    "john@example.com",
+    "jane@example.com"
+  ],
+  "data_available": false
+}