@itentialopensource/adapter-digicert_pki 0.1.1 → 1.1.0

package/entities/EnrollmentProfilePasscodes/schema.json

@@ -0,0 +1,181 @@
+{
+  "$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": [
+        "listEnrollmentPasscodes",
+        "createEnrollmentPasscode",
+        "getEnrollmentPasscodeDetails",
+        "updateEnrollmentPasscode",
+        "deleteEnrollmentPasscode",
+        "restoreEnrollmentPasscode",
+        "disableEnrollmentPasscode",
+        "enableEnrollmentPasscode",
+        "regenerateEnrollmentPasscode"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to enrollment passcodes 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 enrollment passcodes for the division with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Limits results to enrollment passcodes for 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 enrollment passcodes for 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"
+    },    
+    "deviceProfileId": {
+      "type": "string",
+      "description": "Limits results to enrollment passcodes for a device profile with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_profile_id"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits results to enrollment passcodes 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 enrollment passcodes 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 enrollment passcodes 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 enrollment passcodes 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 enrollment passcodes 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 enrollment passcodes 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"
+    },    
+    "passcodeId": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "passcode_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/EnrollmentProfiles/action.json

@@ -0,0 +1,191 @@
+{
+  "actions": [
+    {
+      "name": "listEnrollmentProfiles",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "createEnrollmentProfile",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getExampleCertificateRequestEnrollmentProfileID",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/example-request?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getEnrollmentProfile",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-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/getEnrollmentProfile-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateEnrollmentProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateEnrollmentProfile-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listAssignableICAs",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/assignable-ca?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getIssuingICA",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/issuer?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getEnrollmentProfileSpecification",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/enrollment-specification?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getEnrollmentProfileSpecification-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getEnrollmentProfileStatus",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{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": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/EnrollmentProfiles/mockdatafiles/getEnrollmentProfile-default.json

@@ -0,0 +1,153 @@
+{
+  "name": "Example name",
+  "enrollment_methods": [
+    "API",
+    "PORTAL"
+  ],
+  "allowed_ip_addresses": [
+    "1.1.1.1",
+    "2.2.2.2"
+  ],
+  "allowed_hours_from": "09:45:00",
+  "allowed_hours_to": "17:30:00",
+  "timezone": "America/New_York",
+  "valid_from": "2021-06-25",
+  "expires_on": "2022-06-25",
+  "key_generation_allow_to_change": true,
+  "key_generation_option": null,
+  "key_generation_type": null,
+  "allow_key_cache": false,
+  "key_cache_validity_period_type": null,
+  "key_cache_validity_period": "string",
+  "require_approval_for_enroll": false,
+  "require_approval_for_renew": false,
+  "digest_email_notification_period": null,
+  "approvers": [
+    {
+      "id": "4db36e5c-4bb8-4a41-a941-1b31a82529bd",
+      "full_name": "John Doe",
+      "email": "john.doe@example.com",
+      "active": true,
+      "user_type": null,
+      "locale": null
+    },
+    {
+      "id": "4db36e5c-4bb8-4a41-a941-1b31a82529bd",
+      "full_name": "John Doe",
+      "email": "john.doe@example.com",
+      "active": true,
+      "user_type": null,
+      "locale": null
+    }
+  ],
+  "notification_email_list": [
+    "string",
+    "string",
+    "string",
+    "string",
+    "string",
+    "string",
+    "string",
+    "string"
+  ],
+  "id": "IOT_502ac648-c826-4e71-991e-5629a23850c1",
+  "connector_url": "https://one.digicert.com",
+  "connector_type": null,
+  "passcode": "passcode",
+  "api_key": "<api_token>",
+  "auth_cert_pkcs12": "<auth_cert_pkcs12>",
+  "auth_cert_password_pkcs12": "passcode",
+  "external_enrollment_profile_id": "string",
+  "device_profile": {
+    "id": "f5218cc5-fd11-47ac-bff8-0058f8e2d0ed",
+    "name": "Device profile name"
+  },
+  "certificate_profile": {
+    "id": "880daffe-e70f-4eb3-bfd5-673419cef80b",
+    "name": "Certificate profile name"
+  },
+  "created_at": "2021-06-09T13:49:54Z",
+  "ica": {
+    "id": "AAC2E2DD6BEAE2E5EE93954BAE15E34D",
+    "name": "ICA Name"
+  },
+  "status": null,
+  "allowed_signature_algorithms": [
+    "sha1WithRSA",
+    "sha256WithRSA",
+    "sha384WithRSA",
+    "sha512WithRSA"
+  ],
+  "direct_mapping": true,
+  "account_id": "742a7efb-0cf1-499d-abd5-abb87f42aa5f",
+  "ca_body": "<certificate_data>",
+  "gp_ca_body": "<certificate_data>",
+  "ca_chain": [
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    }
+  ],
+  "gp_ca_chain": [
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    }
+  ],
+  "certificate_template": {
+    "id": "ebe32558-6485-4810-938b-56882daed038",
+    "name": "Certificate Template Name"
+  }
+}

package/entities/EnrollmentProfiles/mockdatafiles/getEnrollmentProfileSpecification-default.json

@@ -0,0 +1,125 @@
+{
+  "fields": [
+    {
+      "id": "csr",
+      "name": "csr",
+      "type": "CERTIFICATE",
+      "mandatory": true,
+      "editable": true,
+      "update_from_csr": false,
+      "value_type": {
+        "type": "string",
+        "options": false,
+        "multiple": false
+      }
+    },
+    {
+      "id": "signature_algorithm",
+      "name": "signature_algorithm",
+      "type": "CERTIFICATE",
+      "mandatory": true,
+      "editable": false,
+      "update_from_csr": false,
+      "value_type": {
+        "type": "string",
+        "options": true,
+        "multiple": false
+      },
+      "default_value": "match_issuer",
+      "options": [
+        "sha1WithRSA",
+        "sha256WithRSA",
+        "sha384WithRSA",
+        "sha512WithRSA",
+        "match_issuer"
+      ]
+    },
+    {
+      "id": "subject.common_name",
+      "name": "subject_common_name",
+      "type": "CERTIFICATE",
+      "mandatory": true,
+      "editable": true,
+      "update_from_csr": true,
+      "value_type": {
+        "type": "string",
+        "options": false,
+        "multiple": false
+      }
+    },
+    {
+      "id": "subject.organization_name",
+      "name": "subject_organization",
+      "type": "CERTIFICATE",
+      "mandatory": true,
+      "editable": true,
+      "update_from_csr": true,
+      "value_type": {
+        "type": "string",
+        "options": false,
+        "multiple": false
+      }
+    },
+    {
+      "id": "validity.duration_unit",
+      "name": "duration_unit",
+      "type": "CERTIFICATE",
+      "mandatory": true,
+      "editable": false,
+      "update_from_csr": false,
+      "value_type": {
+        "type": "string",
+        "options": true,
+        "multiple": false
+      },
+      "default_value": "months",
+      "options": [
+        "days",
+        "months",
+        "years"
+      ]
+    },
+    {
+      "id": "validity.duration_value",
+      "name": "duration_value",
+      "type": "CERTIFICATE",
+      "mandatory": true,
+      "editable": false,
+      "update_from_csr": false,
+      "value_type": {
+        "type": "number",
+        "options": false,
+        "multiple": false
+      },
+      "default_value": 7
+    },
+    {
+      "id": "DEVICE_IDENTIFIER",
+      "name": "Device Identifier",
+      "type": "USER",
+      "mandatory": true,
+      "editable": false,
+      "update_from_csr": false,
+      "value_type": {
+        "type": "string",
+        "options": false,
+        "multiple": false
+      },
+      "default_value": "Provided from subject.common_name"
+    },
+    {
+      "id": "7a2ad21e-38da-4d22-b81a-d94a71f6ae64",
+      "name": "party-no",
+      "type": "USER",
+      "mandatory": true,
+      "editable": false,
+      "update_from_csr": false,
+      "value_type": {
+        "type": "string",
+        "options": false,
+        "multiple": false
+      },
+      "default_value": "Provided from subject.organization_name"
+    }
+  ]
+}