@itentialopensource/adapter-digicert_pki 0.1.1 → 1.1.0

package/entities/Certificates/schema.json

@@ -0,0 +1,462 @@
+{
+  "$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": [
+        "listCertificates",
+        "getExampleCertificateRequestCertificateID",
+        "renewCertificate",
+        "renewBySerial",
+        "revokeCertificate",
+        "updateNote",
+        "revokeCertificateBySerialNumber",
+        "downloadCertificate",
+        "downloadCertificateBySerialNumber",
+        "importCertificate",
+        "getImportDetails",
+        "getCertificateStatus",
+        "getCertificateStatusById",
+        "listCertificatesByCertificateValue",
+        "downloadApprovedCertificate"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to certificates with an account ID that is an exact match for the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "account_id"
+    },    
+    "divisionId": {
+      "type": "string",
+      "description": "Limits results to certificates with a division ID that is an exact match for the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "serialNumber": {
+      "type": "string",
+      "description": "Limits results to certificates with a serial number that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "serial_number"
+    },    
+    "commonName": {
+      "type": "string",
+      "description": "Limits results to certificates with a common name that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "common_name"
+    },    
+    "certificateValue": {
+      "type": "string",
+      "description": "Limits results to certificates with a certificate value that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_value"
+    },    
+    "deviceIdentifier": {
+      "type": "string",
+      "description": "Limits results to certificates with a device name (`device_identifier`) that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_identifier"
+    },    
+    "enrollmentMethod": {
+      "type": "",
+      "description": "Limits results to certificates issued using the given enrollment method.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_method"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits results to certificates created after the given date. UTC timezone. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_from"
+    },    
+    "createdTo": {
+      "type": "string",
+      "description": "Limits results to certificates created before the given date. UTC timezone. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_to"
+    },    
+    "validToStart": {
+      "type": "string",
+      "description": "Limits results to certificates with a `valid_to` value on or after the given date or date-time. Use with `valid_to_end` to search for certificates with a `valid_to` date ...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "valid_to_start"
+    },    
+    "validToEnd": {
+      "type": "string",
+      "description": "Limits results to certificates with a `valid_to` value on or before the given date or date-time. Use with `valid_to_start` to search for certificates with a `valid_to` da...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "valid_to_end"
+    },    
+    "issuerCommonName": {
+      "type": "string",
+      "description": "Limits results to certificates issued from a CA with a common name that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "issuer_common_name"
+    },    
+    "issuerSerialNumber": {
+      "type": "string",
+      "description": "Limits results to certificates issued from the CA with a serial number that is an exact match for the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "issuer_serial_number"
+    },    
+    "keyType": {
+      "type": "string",
+      "description": "Limits results to certificates with key type that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "key_type"
+    },    
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Limits results to certificates issued using an enrollment profile with an ID that is an exact match for the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_id"
+    },    
+    "revokedFrom": {
+      "type": "string",
+      "description": "Limits results to certificates revoked after a specific date. UTC timezone. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "revoked_from"
+    },    
+    "revokedTo": {
+      "type": "string",
+      "description": "Limits results to certificates revoked before a specific date. UTC timezone. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "revoked_to"
+    },    
+    "ocspGroup": {
+      "type": "string",
+      "description": "Filter results using OCSP group ID. Must be an exact match. Modified using `included_in_ocsp_group`.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "ocsp_group"
+    },    
+    "includedInOcspGroup": {
+      "type": "boolean",
+      "description": "If true, limits results to certificates included in the given `ocsp_group`. If false, limits results to certificates excluded from the given `ocsp_group`. If omitted, no ...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "included_in_ocsp_group"
+    },    
+    "deviceId": {
+      "type": "string",
+      "description": "Limits results to certificates with a device ID that is an exact match for the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_id"
+    },    
+    "certificateType": {
+      "type": "",
+      "description": "Limits results to certificates of the given type.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_type"
+    },    
+    "createdInLastNDays": {
+      "type": "number",
+      "description": "Limits results to certificates created in the last *n* days, where *n* is a numerical value you provide in your request.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_in_last_n_days"
+    },    
+    "createdInCurrentMonth": {
+      "type": "boolean",
+      "description": "If true, limits results to certificates created in the current month.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_in_current_month"
+    },    
+    "createdInPreviousMonth": {
+      "type": "boolean",
+      "description": "If true, limits results to certificates created in the previous month.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_in_previous_month"
+    },    
+    "expiringInNextNDays": {
+      "type": "number",
+      "description": "Limits results to certificates expiring in the next *n* days, where *n* is a numerical value you provide in your request.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "expiring_in_next_n_days"
+    },    
+    "expiringInRemainingOfCurrentMonth": {
+      "type": "number",
+      "description": "If true, limits results to certificates expiring before the end of the current month.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "expiring_in_remaining_of_current_month"
+    },    
+    "expiringInNextMonth": {
+      "type": "number",
+      "description": "If true, limits results to certificates expiring before the end of the next month.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "expiring_in_next_month"
+    },    
+    "keyUsage": {
+      "type": "string",
+      "description": "Limits results to certificates with the given key usage extension.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "key_usage"
+    },    
+    "extendedKeyUsage": {
+      "type": "string",
+      "description": "Limits results to certificates with the given extended key usage (EKU) extension.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "extended_key_usage"
+    },    
+    "certificatePolicies": {
+      "type": "string",
+      "description": "Limits results to certificates with the given certificate policies.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_policies"
+    },    
+    "authenticationId": {
+      "type": "string",
+      "description": "Limits results to certificates requested with an authentication ID that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_id"
+    },    
+    "authenticationType": {
+      "type": "",
+      "description": "Limits results to certificates requested with the given authentication type.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_type"
+    },    
+    "authenticationName": {
+      "type": "string",
+      "description": "Limits results to certificates requested with an authentication name that contains the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_name"
+    },    
+    "caConnectorType": {
+      "type": "",
+      "description": "Limits results to certificates with the given CA connector type.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "ca_connector_type"
+    },    
+    "sortBy": {
+      "type": "",
+      "description": "Sorts results by the given property. Case-insensitive. If not provided, results are sorted in descending order by date created (`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"
+    },    
+    "certificateId": {
+      "type": "string",
+      "description": "Certificate ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_id"
+    },    
+    "certificateSerialNumber": {
+      "type": "string",
+      "description": "Certificate serial number.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_serial_number"
+    },    
+    "jobId": {
+      "type": "string",
+      "description": "ID of the certificate import job.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "job_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/DeviceProfiles/action.json

@@ -0,0 +1,126 @@
+{
+  "actions": [
+    {
+      "name": "createDeviceProfile",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/device-profile?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/createDeviceProfile-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listdeviceprofiles",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/device-profile?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listdeviceprofiles-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getDeviceProfile",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/device-profile/{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/getDeviceProfile-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateDeviceProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/device-profile/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateDeviceProfile-default.json"
+        }
+      ]
+    },
+    {
+      "name": "deleteDeviceProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/device-profile/{pathv1}/delete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "restoreDeviceProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/device-profile/{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/DeviceProfiles/mockdatafiles/createDeviceProfile-default.json

@@ -0,0 +1,28 @@
+{
+  "id": "dcfe811c-ecf1-4d2e-bf44-462963bc4ade",
+  "name": "Device profile example",
+  "description": "An example device profile",
+  "status": "ACTIVE",
+  "device_api_allow_read": true,
+  "device_api_allow_write": true,
+  "device_api_allow_revoke": true,
+  "device_api_allow_renew_certificate": true,
+  "device_api_allow_enroll_certificate": false,
+  "fields": [
+    {
+      "id": "226ca489-1ce2-49ef-ab23-5968ae6440ef",
+      "name": "mandatory",
+      "mandatory": true
+    },
+    {
+      "id": "661820ce-4d8b-45bd-af2b-4baf924b8650",
+      "name": "optional",
+      "mandatory": false
+    }
+  ],
+  "division": {
+    "id": "d5faa1e-623a-47a9-831b-b9397c33395f",
+    "name": "IoT Account"
+  },
+  "account_id": "f92834ce-cdea-1584-b154-193bb198345e"
+}

package/entities/DeviceProfiles/mockdatafiles/getDeviceProfile-default.json

@@ -0,0 +1,28 @@
+{
+  "id": "dcfe811c-ecf1-4d2e-bf44-462963bc4ade",
+  "name": "Device profile example",
+  "description": "An example device profile",
+  "status": "ACTIVE",
+  "device_api_allow_read": true,
+  "device_api_allow_write": true,
+  "device_api_allow_revoke": true,
+  "device_api_allow_renew_certificate": true,
+  "device_api_allow_enroll_certificate": false,
+  "fields": [
+    {
+      "id": "226ca489-1ce2-49ef-ab23-5968ae6440ef",
+      "name": "mandatory",
+      "mandatory": true
+    },
+    {
+      "id": "661820ce-4d8b-45bd-af2b-4baf924b8650",
+      "name": "optional",
+      "mandatory": false
+    }
+  ],
+  "division": {
+    "id": "d5faa1e-623a-47a9-831b-b9397c33395f",
+    "name": "IoT Account"
+  },
+  "account_id": "f92834ce-cdea-1584-b154-193bb198345e"
+}