@itentialopensource/adapter-digicert_pki 0.1.1 → 1.0.0

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

@@ -0,0 +1,22 @@
+{
+  "id": "da342f63-dead-4bae-a065-eb8822948148",
+  "name": "Example batch job",
+  "status": null,
+  "total_items": 10,
+  "failed_items": 7,
+  "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
+}

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

@@ -0,0 +1,22 @@
+{
+  "id": "da342f63-dead-4bae-a065-eb8822948148",
+  "name": "Example batch job",
+  "status": null,
+  "total_items": 10,
+  "failed_items": 1,
+  "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": true
+}

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

@@ -0,0 +1,18 @@
+{
+  "job_id": "04fa5382-00e0-4322-813d-fcce9747d51f",
+  "chain": [
+    {
+      "cert_type": "intermediate",
+      "blob": "MII...",
+      "common_name": "Issuing CA name"
+    }
+  ],
+  "certificates": [
+    {
+      "id": "a8a84a9c-313d-4714-a154-a46bae0a80d9",
+      "unique_identifier": "b0-f4-a8-10-53-0f",
+      "body": "-----BEGIN CERTIFICATE-----\nMII...\n-----END CERTIFICATE-----\n",
+      "private_key": "<private_key>"
+    }
+  ]
+}

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

@@ -0,0 +1,22 @@
+{
+  "id": "e197ba9d-3af3-4012-9861-d214cce33cd8",
+  "name": "Example batch job",
+  "status": null,
+  "total_items": 10,
+  "failed_items": 9,
+  "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
+}

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

@@ -0,0 +1,22 @@
+{
+  "id": "da342f63-dead-4bae-a065-eb8822948148",
+  "name": "Example batch job",
+  "status": null,
+  "total_items": 10,
+  "failed_items": 9,
+  "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": true
+}

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

@@ -0,0 +1,22 @@
+{
+  "id": "42dbf316-6618-4ab2-9770-5ce7e0c9d62c",
+  "name": "Example batch job",
+  "status": null,
+  "total_items": 10,
+  "failed_items": 3,
+  "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
+}

package/entities/BatchCertificateEnrollment/schema.json

@@ -0,0 +1,284 @@
+{
+  "$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": [
+        "batchCSREnroll",
+        "batchEnrollWithKeyGen",
+        "batchEnrollWithKeyGenMac",
+        "listBatchJobs",
+        "getBatchJobSettings",
+        "updateBatchJobSettings",
+        "regenerateBatchJobPasscode",
+        "approveJob",
+        "rejectJob",
+        "downloadReport",
+        "downloadCertificates",
+        "deleteDownloadUrls",
+        "resendDownloadUrls"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Enrollment profile ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_id"
+    },    
+    "certificateFormat": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_format"
+    },    
+    "externalEmails": {
+      "type": "array",
+      "description": "List of email addresses that receive a unique download link when the batch job is complete. Use this field to allow individuals without accounts to download the certifica...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "external_emails"
+    },    
+    "passcodeGenerationOption": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "passcode_generation_option"
+    },    
+    "inputFormat": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "input_format"
+    },    
+    "reportFormat": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "report_format"
+    },    
+    "privateKeyFormat": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "private_key_format"
+    },    
+    "privateKeySyntax": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "private_key_syntax"
+    },    
+    "keyType": {
+      "type": "",
+      "description": "",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "key_type"
+    },    
+    "macAddressFrom": {
+      "type": "string",
+      "description": "Starting MAC address. Format: `XX:XX:XX:XX:XX:XX` or `XX-XX-XX-XX-XX-XX`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "mac_address_from"
+    },    
+    "macAddressNumber": {
+      "type": "number",
+      "description": "Number of certificates to request.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "mac_address_number"
+    },    
+    "macAddressStep": {
+      "type": "number",
+      "description": "Number to increment each MAC address by.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "mac_address_step"
+    },    
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to batch enrollment jobs 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 batch enrollment jobs for the division with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "division_id"
+    },    
+    "fileName": {
+      "type": "string",
+      "description": "Limits results to batch enrollment jobs created from a file with a name (`file_name`) that contains the given string. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "file_name"
+    },    
+    "createdAtFrom": {
+      "type": "string",
+      "description": "Limits results to batch enrollment jobs created **after** the given date and time (UTC). Use with `created_at_to` to search for credentials with a `created_at` date in a ...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_at_from"
+    },    
+    "createdAtTo": {
+      "type": "string",
+      "description": "Limits results to batch enrollment jobs created **before** the given date and time (UTC). Use with `created_at_from` to search for credentials with a `created_at` date in...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_at_to"
+    },    
+    "requestedById": {
+      "type": "string",
+      "description": "Limits results to batch enrollment jobs requested by the user with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "requested_by_id"
+    },    
+    "approvedById": {
+      "type": "string",
+      "description": "Limits results to batch enrollment jobs approved by the user with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "approved_by_id"
+    },    
+    "dataAvailable": {
+      "type": "boolean",
+      "description": "If true, limits results to batch enrollment jobs with results available for download. If false, limits results to batch enrollment jobs without results available for down...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "data_available"
+    },    
+    "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 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"
+    },    
+    "jobId": {
+      "type": "string",
+      "description": "Batch certificate enrollment job ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "job_id"
+    }
+  },
+  "definitions": {}
+}

package/entities/CertificateProfiles/action.json

@@ -0,0 +1,206 @@
+{
+  "actions": [
+    {
+      "name": "listCertificateProfiles",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-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/listCertificateProfiles-default.json"
+        }
+      ]
+    },
+    {
+      "name": "createCertificateProfile",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-profile?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getCertificateProfile",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-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": ""
+        }
+      ]
+    },
+    {
+      "name": "updateCertificateProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-profile/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "disableCertificateProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-profile/{pathv1}/disable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "enableCertificateProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-profile/{pathv1}/enable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteCertificateProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-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": "restoreCertificateProfile",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-profile/{pathv1}/undelete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "assignCertificateProfileDivisions",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-profile/{pathv1}/division/assign?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "unassignCertificateProfileDivisions",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-profile/{pathv1}/division/unassign?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}