@itentialopensource/adapter-digicert_pki 0.1.1 → 1.0.0

package/entities/AuthenticationCATemplates/action.json

@@ -0,0 +1,187 @@
+{
+  "actions": [
+    {
+      "name": "createAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-template?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/createAuthenticationCATemplate-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-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": "updateAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-template/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateAuthenticationCATemplate-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-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": "mockdatafiles/getAuthenticationCATemplate-default.json"
+        }
+      ]
+    },
+    {
+      "name": "disableAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-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": "deleteAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-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": "restoreAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-template/{pathv1}/undelete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "enableAuthenticationCATemplate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-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": "listAssignableAuthenticationCACertificates",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/cert-auth-template/assignable-ca/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/AuthenticationCATemplates/mockdatafiles/createAuthenticationCATemplate-default.json

@@ -0,0 +1,33 @@
+{
+  "id": "55f6e0e5-8cbf-4f7b-a623-f5b9689a0dc2",
+  "name": "Example authentication CA template",
+  "certificate_attributes": [
+    "subject.common_name",
+    "subject.organization_name"
+  ],
+  "registered_values": [
+    {
+      "certificate_field": "subject.country",
+      "matcher": "equals",
+      "value": "US",
+      "multiple": false
+    }
+  ],
+  "enrollment_profile_id": "IOT_58b96f06-bf12-49a4-939e-7247f147ec3e",
+  "enrollment_profile_name": "Example enrollment profile",
+  "ica_common_name": "IoT Example ICA",
+  "ica_body": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
+  "organization": "IoT Example Organization",
+  "parent_ca": "IoT Example Root",
+  "signature_algorithm": "1.2.840.10045.4.3.2",
+  "key_type": "EC prime256v1",
+  "can_be_used_for_any_certificate": false,
+  "certificate_authentication_type": "certificate_body_and_attributes",
+  "usage_limit": 20,
+  "start_date": "2022-07-21T00:00:00Z",
+  "end_date": "2022-07-31T00:00:00Z",
+  "expiry_date": "2049-01-01",
+  "status": "ACTIVE",
+  "created_at": "2022-07-21T10:09:13Z",
+  "force_passcode_for_auth_cert": false
+}

package/entities/AuthenticationCATemplates/mockdatafiles/getAuthenticationCATemplate-default.json

@@ -0,0 +1,33 @@
+{
+  "id": "55f6e0e5-8cbf-4f7b-a623-f5b9689a0dc2",
+  "name": "Example authentication CA template",
+  "certificate_attributes": [
+    "subject.common_name",
+    "subject.organization_name"
+  ],
+  "registered_values": [
+    {
+      "certificate_field": "subject.country",
+      "matcher": "equals",
+      "value": "US",
+      "multiple": false
+    }
+  ],
+  "enrollment_profile_id": "IOT_58b96f06-bf12-49a4-939e-7247f147ec3e",
+  "enrollment_profile_name": "Example enrollment profile",
+  "ica_common_name": "IoT Example ICA",
+  "ica_body": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
+  "organization": "IoT Example Organization",
+  "parent_ca": "IoT Example Root",
+  "signature_algorithm": "1.2.840.10045.4.3.2",
+  "key_type": "EC prime256v1",
+  "can_be_used_for_any_certificate": false,
+  "certificate_authentication_type": "certificate_body_and_attributes",
+  "usage_limit": 20,
+  "start_date": "2022-07-21T00:00:00Z",
+  "end_date": "2022-07-31T00:00:00Z",
+  "expiry_date": "2049-01-01",
+  "status": "ACTIVE",
+  "created_at": "2022-07-21T10:09:13Z",
+  "force_passcode_for_auth_cert": false
+}

package/entities/AuthenticationCATemplates/mockdatafiles/updateAuthenticationCATemplate-default.json

@@ -0,0 +1,33 @@
+{
+  "id": "55f6e0e5-8cbf-4f7b-a623-f5b9689a0dc2",
+  "name": "Example authentication CA template",
+  "certificate_attributes": [
+    "subject.common_name",
+    "subject.organization_name"
+  ],
+  "registered_values": [
+    {
+      "certificate_field": "subject.country",
+      "matcher": "equals",
+      "value": "US",
+      "multiple": false
+    }
+  ],
+  "enrollment_profile_id": "IOT_58b96f06-bf12-49a4-939e-7247f147ec3e",
+  "enrollment_profile_name": "Example enrollment profile",
+  "ica_common_name": "IoT Example ICA",
+  "ica_body": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
+  "organization": "IoT Example Organization",
+  "parent_ca": "IoT Example Root",
+  "signature_algorithm": "1.2.840.10045.4.3.2",
+  "key_type": "EC prime256v1",
+  "can_be_used_for_any_certificate": false,
+  "certificate_authentication_type": "certificate_body_and_attributes",
+  "usage_limit": 20,
+  "start_date": "2022-07-21T00:00:00Z",
+  "end_date": "2022-07-31T00:00:00Z",
+  "expiry_date": "2049-01-01",
+  "status": "ACTIVE",
+  "created_at": "2022-07-21T10:09:13Z",
+  "force_passcode_for_auth_cert": false
+}

package/entities/AuthenticationCATemplates/schema.json

@@ -0,0 +1,137 @@
+{
+  "$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": [
+        "createAuthenticationCATemplate",
+        "listAuthenticationCATemplate",
+        "updateAuthenticationCATemplate",
+        "getAuthenticationCATemplate",
+        "disableAuthenticationCATemplate",
+        "deleteAuthenticationCATemplate",
+        "restoreAuthenticationCATemplate",
+        "enableAuthenticationCATemplate",
+        "listAssignableAuthenticationCACertificates"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to authentication CA 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"
+    },    
+    "divisionId": {
+      "type": "string",
+      "description": "Limits results to authentication CA templates for the given division.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Limits results to authentication CA templates for the given enrollment profile.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_id"
+    },    
+    "icaId": {
+      "type": "string",
+      "description": "Limits results to authentication CA templates that use the given authentication CA certificate.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "ica_id"
+    },    
+    "useForAllCertificates": {
+      "type": "boolean",
+      "description": "Filter by value of the `can_be_used_for_any_certificate` field.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "use_for_all_certificates"
+    },    
+    "createdAtFrom": {
+      "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_at_from"
+    },    
+    "createdAtTo": {
+      "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_at_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"
+    },    
+    "authenticationCaTemplateId": {
+      "type": "string",
+      "description": "Authentication CA template ID (UUID).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_ca_template_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/AuthenticationCertificates/action.json

@@ -0,0 +1,166 @@
+{
+  "actions": [
+    {
+      "name": "addAuthenticationCertificate",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/addAuthenticationCertificate-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listAuthenticationCertificates",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listAuthenticationCertificates-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getAuthenticationCertificateDetails",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate/{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/getAuthenticationCertificateDetails-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateAuthenticationCertificate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateAuthenticationCertificate-default.json"
+        }
+      ]
+    },
+    {
+      "name": "disableAuthenticationCertificate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/disable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "enableAuthenticationCertificate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/enable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteAuthenticationCertificate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate/{pathv1}/delete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "restoreAuthenticationCertificate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-certificate/{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/AuthenticationCertificates/mockdatafiles/addAuthenticationCertificate-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": []
+}