Authority Provider v2 API (2.18.0)

Download OpenAPI specification:Download

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for implementations of custom v2 Authority Provider

Connector Info

Connector Information API. Each connector may have multiple functions represented by FunctionGroupCode. For each FunctionGroupCode there is a list of implemented end points. These endpoints must be according the specified interface, this is validated by the core. You can also implement helper end points that are used for callbacks and other relevant operations specific to implementation.

List supported functions of the connector

Returns map of functional code and implemented end points

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"functionGroupCode": "credentialProvider",
"kinds": ["SoftKeyStore",
"Basic",
"ApiKey"
],
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": true
}
]
}
]

Certificate Management

Certificate Management API

Revoke Certificate

Revoke a certificate. The Authority Provider may complete the operation synchronously or asynchronously.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

reason required	string (CertificateRevocationReason) Enum: "unspecified" "keyCompromise" "cACompromise" "affiliationChanged" "superseded" "cessationOfOperation" "certificateHold" "privilegeWithdrawn" "aACompromise" Revocation reason
required	Array of objects (RequestAttribute) List of RA Profiles attributes
required	Array of objects (RequestAttribute) List of Attributes to revoke Certificate
certificate required	string Base64 Certificate content. (Certificate to be revoked)

Responses

Request samples

Payload

Content type

application/json

{"reason": "unspecified",
"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"certificate": "string"
}

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

Get Certificate Revocation Status

Return the current status of an asynchronous certificate revocation.

Called for an asynchronous revocation that previously responded 202 Accepted. For revocation, the certificateData field of the response is unused (revocation completion carries no payload).

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of RA Profile attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Technology-specific metadata that was returned by the Authority Provider in the original `202 Accepted` response, sent back here so the Authority Provider can resolve the in-flight operation and report its status.

Responses

Request samples

Payload

Content type

application/json

{"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"status": "inProgress",
"certificateData": "string",
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
],
"reason": "string"
}

Cancel Certificate Revocation

Abort an in-flight certificate revocation.

Called for an asynchronous revocation that previously responded 202 Accepted. The request body carries the RA profile attributes and the same MetadataAttribute entries returned in the original 202 Accepted response.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of RA Profile attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Technology-specific metadata that was returned by the Authority Provider in the original `202 Accepted` response, sent back here so the Authority Provider can identify the in-flight operation it must abort.

Responses

Request samples

Payload

Content type

application/json

{"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

422

Content type

*/*

[
  "CA does not support cancellation",
  "Revocation already submitted to CRL"
]

Validate list of Attributes to revoke certificate

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

Renew Certificate

Renew a certificate. The Authority Provider may complete the operation synchronously or asynchronously.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

request required	string Certificate signing request encoded as Base64 string
format	string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format
required	Array of objects (RequestAttribute) List of RA Profiles attributes
certificate required	string Base64 Certificate content. (Certificate to be renewed)
required	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Metadata for the Certificate

Responses

Request samples

Payload

Content type

application/json

{"request": "string",
"format": "pkcs10",
"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"certificate": "string",
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string",
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
],
"certificateType": "X.509"
}

Issue Certificate

Issue a certificate. The Authority Provider may complete the operation synchronously or asynchronously.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

request required	string Certificate signing request encoded as Base64 string
format	string (CertificateRequestFormat) Default: "pkcs10" Enum: "pkcs10" "crmf" Certificate signing request format
required	Array of objects (RequestAttribute) List of RA Profiles attributes
required	Array of objects (RequestAttribute) List of Attributes to issue Certificate

Responses

Request samples

Payload

Content type

application/json

{"request": "string",
"format": "pkcs10",
"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

Content type

application/json

{"certificateData": "string",
"uuid": "string",
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
],
"certificateType": "X.509"
}

Get Certificate Issuance Status

Return the current status of an asynchronous certificate issuance.

Called for an asynchronous issuance or renewal that previously responded 202 Accepted. The request body carries the RA profile attributes and the same MetadataAttribute entries returned in the original 202 Accepted response, so the Authority Provider can resolve the operation.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of RA Profile attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Technology-specific metadata that was returned by the Authority Provider in the original `202 Accepted` response, sent back here so the Authority Provider can resolve the in-flight operation and report its status.

Responses

Request samples

Payload

Content type

application/json

{"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"status": "inProgress",
"certificateData": "string",
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
],
"reason": "string"
}

Cancel Certificate Issuance or Renewal

Abort an in-flight certificate issuance or renewal.

Called for an asynchronous issuance, renewal, or rekey that previously responded 202 Accepted. The request body carries the RA profile attributes and the same MetadataAttribute entries returned in the original 202 Accepted response, so the Authority Provider can resolve the operation it must abort.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttribute) List of RA Profile attributes
	Array of MetadataAttributeV2 (object) or MetadataAttributeV3 (object) (MetadataAttribute) Technology-specific metadata that was returned by the Authority Provider in the original `202 Accepted` response, sent back here so the Authority Provider can identify the in-flight operation it must abort.

Responses

Request samples

Payload

Content type

application/json

{"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

Response samples

422

Content type

*/*

[
  "CA does not support cancellation",
  "Issuance is past the point of no return"
]

Validate list of Attributes to issue Certificate

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

Identify Certificate

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

certificate required	string Base64 Certificate content. (certificate to be identified)
required	Array of objects (RequestAttribute) List of RA Profiles attributes

Responses

Request samples

Payload

Content type

application/json

{"certificate": "string",
"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
]
}

List of Attributes to revoke Certificate

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Responses

Response samples

200
400
403
404
422

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

List of Attributes to issue Certificate

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Health check

Connector Health check API. Connector returns own status and in some cases can return status of services on which it depends like database, HSM and so on.

Health check

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
400
403
404

Content type

application/json

{"status": "ok",
"description": "string",
"parts": {"property1": { },
"property2": { }
}
}

Authority Management

Authority Management API

List Authority instances

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]
}
]

Create Authority instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

Request Body schema: application/json
required

name required	string Authority instance name
kind required	string Kind of Authority instance
required	Array of objects (RequestAttribute) List of Authority instance Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]
}

Get an Authority instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]
}

Update Authority instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

name required	string Authority instance name
kind required	string Kind of Authority instance
required	Array of objects (RequestAttribute) List of Authority instance Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"attributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]
}

Remove Authority instance

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Validate RA Profile attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Get the latest CRL for the Authority Instance

Returns the latest CRL for the Authority Instance. If delta is true, the delta CRL is returned, otherwise the full CRL is returned. When the CRL is not available for Authority Instance, null data is returned.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

delta	boolean Default: false If true, the delta CRL is returned, otherwise the full CRL is returned
required	Array of objects (RequestAttribute) List of RA Profiles attributes

Responses

Request samples

Payload

Content type

application/json

{"delta": false,
"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"crlData": "string"
}

Get the Authority Instance's certificate chain

Returns the Authority Instance's certificate chain. The chain is returned as a list of Base64 encoded certificates, starting with the Authority Instance's certificate and ending with the root certificate, if available.

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Request Body schema: application/json
required

required

Array of objects (RequestAttribute)

List of RA Profiles attributes

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

{"raProfileAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"certificates": [{"certificateData": "string",
"uuid": "string",
"meta": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"description": "string",
"version": 0,
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false,
"protectionLevel": "none"
}
}
],
"certificateType": "X.509"
}
]
}

List RA Profile Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Connect to Authority

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

uuid

required

string

Authority Instance UUID

Responses

Response samples

400
403
404

Content type

application/json

{"message": "Error message"
}

Connector Attributes

Connector Attributes API. Provides information about supported Attributes of the connector. Attributes are specific to implementation and gives information about the data that can be exchanged and properly parsed by the connector. Part of this API is validation of the Attributes.

Validate Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

functionalGroup required	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider" Function Group
kind required	string Kind

Request Body schema: application/json
required

Array

uuid required	string <uuid> UUID of the Attribute
name required	string Name of the Attribute
contentType required	string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" Content Type of the Attribute
	Array of BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

List available Attributes

Authorizations:

NoAuthCertificateTLSAuthConnectorAPIKeyAuthBasicAuth

path Parameters

functionalGroup required	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "complianceProviderV2" "cryptographyProvider" "notificationProvider" Function Group
kind required	string Kind

Responses

Response samples

200
400
403
404

Content type

application/json

[{"name": "Attribute",
"type": "data",
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"description": "string",
"version": 0,
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false,
"protectionLevel": "none",
"resource": "certificates",
"extensibleList": false
},
"constraints": [{"type": "regExp",
"errorMessage": "string",
"description": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": null
}
]
}
}
]

Authority Provider v2 API (2.18.0)

Connector Info

List supported functions of the connector

Authorizations:

Responses

Response samples

Certificate Management

Revoke Certificate

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Certificate Revocation Status

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Cancel Certificate Revocation

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate list of Attributes to revoke certificate

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Renew Certificate

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Issue Certificate

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Certificate Issuance Status

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Cancel Certificate Issuance or Renewal

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate list of Attributes to issue Certificate

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Identify Certificate

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List of Attributes to revoke Certificate

Authorizations:

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required