@itentialopensource/adapter-digicert_pki 0.1.1 → 1.0.0

package/entities/ACME/action.json

@@ -0,0 +1,166 @@
+{
+  "actions": [
+    {
+      "name": "createAcmeAuthentication",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/createAcmeAuthentication-default.json"
+        }
+      ]
+    },
+    {
+      "name": "listAcmeAuthentication",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/listAcmeAuthentication-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getAcmeAuthentication",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication/{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/getAcmeAuthentication-default.json"
+        }
+      ]
+    },
+    {
+      "name": "updateAcmeAuthentication",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/updateAcmeAuthentication-default.json"
+        }
+      ]
+    },
+    {
+      "name": "disableAcmeAuthentication",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication/{pathv1}/disable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "enableAcmeAuthentication",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication/{pathv1}/enable?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteAcmeAuthentication",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication/{pathv1}/delete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "restoreAcmeAuthentication",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/acme-authentication/{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/ACME/mockdatafiles/createAcmeAuthentication-default.json

@@ -0,0 +1,21 @@
+{
+  "id": "f92834ce-cdea-1584-b154-193bb198345e",
+  "name": "Example ACME Credentials",
+  "description": "Test",
+  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+  "authentication_pem": "-----BEGIN PUBLIC KEY-----...",
+  "authentication_type": null,
+  "thumbprint": "9e00a421268a1e814805cb0571a157d2fdbd9b48a02286c77d4e76110727727d",
+  "status": "ACTIVE",
+  "created_at": "2021-02-18T21:02:15.285249Z",
+  "key_type": null,
+  "rsa_key_size": 3,
+  "ecdsa_curve": "string",
+  "key_description": "string",
+  "certificate_common_name": "example_common_name",
+  "issuer_common_name": "example_issuing_certificate",
+  "hmac_key": "FS3f8Q7yUZQQO4uLUP8vAyREMCKyUqRr7JoHy1aquKiPYwu42r67CcELWlYRy9oJyzJ09n5oojJzz9t0EhWiNQ",
+  "external_account_binding": true,
+  "account_bind": false,
+  "public_key_pem": "----BEGIN PUBLIC KEY-----..."
+}

package/entities/ACME/mockdatafiles/getAcmeAuthentication-default.json

@@ -0,0 +1,21 @@
+{
+  "id": "f92834ce-cdea-1584-b154-193bb198345e",
+  "name": "Example ACME Credentials",
+  "description": "Test",
+  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+  "authentication_pem": "-----BEGIN PUBLIC KEY-----...",
+  "authentication_type": null,
+  "thumbprint": "9e00a421268a1e814805cb0571a157d2fdbd9b48a02286c77d4e76110727727d",
+  "status": "ACTIVE",
+  "created_at": "2021-02-18T21:02:15.285249Z",
+  "key_type": null,
+  "rsa_key_size": 8,
+  "ecdsa_curve": "string",
+  "key_description": "string",
+  "certificate_common_name": "example_common_name",
+  "issuer_common_name": "example_issuing_certificate",
+  "hmac_key": "FS3f8Q7yUZQQO4uLUP8vAyREMCKyUqRr7JoHy1aquKiPYwu42r67CcELWlYRy9oJyzJ09n5oojJzz9t0EhWiNQ",
+  "external_account_binding": true,
+  "account_bind": false,
+  "public_key_pem": "----BEGIN PUBLIC KEY-----..."
+}

package/entities/ACME/mockdatafiles/listAcmeAuthentication-default.json

@@ -0,0 +1,41 @@
+{
+  "limit": 20,
+  "offset": 0,
+  "pagination": true,
+  "next": false,
+  "total": 2,
+  "records": [
+    {
+      "id": "f92834ce-cdea-1584-b154-193bb198345e",
+      "name": "Example ACME Credentials",
+      "description": "Test",
+      "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+      "status": "ACTIVE",
+      "created_at": "2021-02-18T21:02:15.285249Z",
+      "hmac_key": "FS3f8Q7yUZQQO4uLUP8vAyREMCKyUqRr7JoHy1aquKiPYwu42r67CcELWlYRy9oJyzJ09n5oojJzz9t0EhWiNQ",
+      "external_account_binding": true,
+      "account_bind": false,
+      "enrollment_profiles_assigned": 1
+    },
+    {
+      "id": "f92834ce-cdea-1584-b154-193bb198345e",
+      "name": "Example",
+      "description": "Example",
+      "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+      "authentication_pem": "-----BEGIN CERTIFICATE-----...",
+      "authentication_type": "certificate",
+      "thumbprint": "f99a9e95b9b7c40b985b36ea7a444801ed177ad5bd9aa4464f53694df2b98143",
+      "status": "ACTIVE",
+      "created_at": "2021-02-18T20:43:01.850786Z",
+      "key_type": "RSA",
+      "rsa_key_size": 2048,
+      "key_description": "RSA 2048",
+      "certificate_common_name": "Example Common Name",
+      "issuer_common_name": "Example Issuing CA",
+      "external_account_binding": false,
+      "account_bind": true,
+      "public_key_pem": "-----BEGIN PUBLIC KEY-----...",
+      "enrollment_profiles_assigned": 1
+    }
+  ]
+}

package/entities/ACME/mockdatafiles/updateAcmeAuthentication-default.json

@@ -0,0 +1,21 @@
+{
+  "id": "f92834ce-cdea-1584-b154-193bb198345e",
+  "name": "Example ACME Credentials",
+  "description": "Test",
+  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
+  "authentication_pem": "-----BEGIN PUBLIC KEY-----...",
+  "authentication_type": null,
+  "thumbprint": "9e00a421268a1e814805cb0571a157d2fdbd9b48a02286c77d4e76110727727d",
+  "status": "ACTIVE",
+  "created_at": "2021-02-18T21:02:15.285249Z",
+  "key_type": null,
+  "rsa_key_size": 1,
+  "ecdsa_curve": "string",
+  "key_description": "string",
+  "certificate_common_name": "example_common_name",
+  "issuer_common_name": "example_issuing_certificate",
+  "hmac_key": "FS3f8Q7yUZQQO4uLUP8vAyREMCKyUqRr7JoHy1aquKiPYwu42r67CcELWlYRy9oJyzJ09n5oojJzz9t0EhWiNQ",
+  "external_account_binding": true,
+  "account_bind": false,
+  "public_key_pem": "----BEGIN PUBLIC KEY-----..."
+}

package/entities/ACME/schema.json

@@ -0,0 +1,125 @@
+{
+  "$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": [
+        "createAcmeAuthentication",
+        "listAcmeAuthentication",
+        "getAcmeAuthentication",
+        "updateAcmeAuthentication",
+        "disableAcmeAuthentication",
+        "enableAcmeAuthentication",
+        "deleteAcmeAuthentication",
+        "restoreAcmeAuthentication"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to ACME authentication credentials for the account with the given ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "account_id"
+    },    
+    "createdAtFrom": {
+      "type": "string",
+      "description": "Limits results to ACME authentication credentials created **after** the given date and time (UTC). Use with `created_at_to` to search for credentials with a `created_at` ...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_at_from"
+    },    
+    "createdAtTo": {
+      "type": "string",
+      "description": "Limits results to ACME authentication credentials created **before** the given date and time (UTC). Use with `created_at_from` to search for credentials with a `created_a...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_at_to"
+    },    
+    "certificateCommonName": {
+      "type": "string",
+      "description": "Limits results to ACME authentication credentials with a `certificate_common_name` containing the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_common_name"
+    },    
+    "issuerCommonName": {
+      "type": "string",
+      "description": "Limits results to ACME authentication credentials with an `issuer_common_name` containing the given string.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "issuer_common_name"
+    },    
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Limits results to ACME authentication credentials assigned to specific enrollment profile with id `enrollment_profile_id`.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_id"
+    },    
+    "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"
+    },    
+    "acmeAuthenticationId": {
+      "type": "string",
+      "description": "ID of ACME authentication credentials.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "acme_authentication_id"
+    }    
+  },
+  "definitions": {}
+}

package/entities/AuthenticationCACertificates/action.json

@@ -0,0 +1,107 @@
+{
+  "actions": [
+    {
+      "name": "listAuthenticationCACertificates",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/authentication-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": "listAuthenticationCACertificatesByAccount",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/account/{pathv1}/authentication-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": "uploadAuthenticationCACertificate",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "FORM",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getAuthenticationCACertificate",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteAuthenticationCACertificate",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "{base_path}/{version}/api/v1/account/{pathv1}/authentication-ca/{pathv2}/delete?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    }
+  ]
+}

package/entities/AuthenticationCACertificates/schema.json

@@ -0,0 +1,155 @@
+{
+  "$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": [
+        "listAuthenticationCACertificates",
+        "listAuthenticationCACertificatesByAccount",
+        "uploadAuthenticationCACertificate",
+        "getAuthenticationCACertificate",
+        "deleteAuthenticationCACertificate"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "accountId": {
+      "type": "string",
+      "description": "Limits results to authentication CA certificates for the given account.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "account_id"
+    },    
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Limits results to authentication CA certificates used in the given enrollment profile (UUID).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_id"
+    },    
+    "enrollmentProfileName": {
+      "type": "string",
+      "description": "Limits results to authentication CA certificates used in an enrollment profile with the given name.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_name"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits results to authentication CA 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 CA certificates created before the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_to"
+    },    
+    "validFromStart": {
+      "type": "string",
+      "description": "Limits results to authentication CA certificates with a `valid_from` value on or after the given date or date-time. Use with `valid_from_end` to search for authentication...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "valid_from_start"
+    },    
+    "validFromEnd": {
+      "type": "string",
+      "description": "Limits results to authentication CA certificates with a `valid_from` value on or before the given date or date-time. Use with `valid_from_start` to search for authenticat...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "valid_from_end"
+    },    
+    "validToStart": {
+      "type": "string",
+      "description": "Limits results to authentication CA certificates with a `valid_to` value on or after the given date or date-time. Use with `valid_to_end` to search for authentication CAs...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "valid_to_start"
+    },    
+    "validToEnd": {
+      "type": "string",
+      "description": "Limits results to authentication CA certificates with a `valid_to` value on or before the given date or date-time. Use with `valid_to_start` to search for authentication ...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "valid_to_end"
+    },    
+    "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"
+    },    
+    "authenticationCaId": {
+      "type": "string",
+      "description": "Authentication CA certificate ID (UUID).",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "authentication_ca_id"
+    }      
+  },
+  "definitions": {}
+}