CZERTAINLY Discovery Provider API (2.13.1)

Download OpenAPI specification:Download

CZERTAINLY: info@czertainly.com URL: https://www.czertainly.com License: MIT License

REST API for implementations of custom Discovery Provider

Discovery

Discovery Provider API. Used to schedule and establish certificate discovery process. Once the discovery process is started, the progress and the history of the certificate discovery can be requested. Discovery provides information about discovered certificates and meta data that are specific to implementation of the discovery provider.

Initiate certificate Discovery

Request Body schema: application/json
required

name required	string Name of the Discovery
kind required	string Discovery Kind
	Array of objects (RequestAttributeDto) Discovery Provider Attributes. Mandatory for creating new Discovery

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
404
422

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"status": "inProgress",
"totalCertificatesDiscovered": 0,
"certificateData": [{"uuid": "string",
"base64Content": "string",
"meta": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false
}
}
]
}
],
"meta": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false
}
}
]
}

Get Discovery status and result

path Parameters

uuid

required

string

Discovery UUID

Request Body schema: application/json
required

name required	string Name of the Discovery
kind required	string Discovery Kind
pageNumber required	integer <int32> Page number for the retrieved certificates
itemsPerPage required	integer <int32> Number of certificates per page

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"kind": "string",
"pageNumber": 0,
"itemsPerPage": 0
}

Response samples

200
400
404

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"status": "inProgress",
"totalCertificatesDiscovered": 0,
"certificateData": [{"uuid": "string",
"base64Content": "string",
"meta": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false
}
}
]
}
],
"meta": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"content": [{"reference": "string",
"data": true
}
],
"type": "data",
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"global": false,
"overwrite": false
}
}
]
}

Delete Discovery

path Parameters

uuid

required

string

Discovery UUID

Responses

Response samples

400
404

Content type

application/json

{"message": "Error message"
}

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

Responses

Response samples

200
400
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
}
]
}
]

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

Responses

Response samples

200
400
404

Content type

application/json

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

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

path Parameters

kind

required

string

Kind

Request Body schema: application/json
required

Array

uuid required	string 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" Type of the attribute content.
required	Array of BooleanAttributeContent (object) or CodeBlockAttributeContent (object) or CredentialAttributeContent (object) or DateAttributeContent (object) or DateTimeAttributeContent (object) or FileAttributeContent (object) or FloatAttributeContent (object) or IntegerAttributeContent (object) or ObjectAttributeContent (object) or SecretAttributeContent (object) or StringAttributeContent (object) or TextAttributeContent (object) or TimeAttributeContent (object) (BaseAttributeContentDto) Content of the Attribute

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]

Response samples

400
404
422

Content type

application/json

{"message": "Error message"
}

List available Attributes

path Parameters

kind

required

string

Kind

Responses

Response samples

200
400
404

Content type

application/json

[{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"description": "string",
"type": "data",
"content": [{"reference": "string",
"data": true
}
],
"contentType": "string",
"properties": {"label": "Attribute Name",
"visible": true,
"group": "requiredAttributes",
"required": false,
"readOnly": false,
"list": false,
"multiSelect": false
},
"constraints": [{"description": "string",
"errorMessage": "string",
"type": "regExp",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

CZERTAINLY Discovery Provider API (2.13.1)

Discovery

Initiate certificate Discovery

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Discovery status and result

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Discovery

path Parameters

Responses

Response samples

Connector Info

List supported functions of the connector

Responses

Response samples

Health check

Health check

Responses

Response samples

Connector Attributes

Validate Attributes

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List available Attributes

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required