CZERTAINLY Connector API (2.14.1)

Download OpenAPI specification:Download

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

REST API for managing Connectors in the platform

CZERTAINLY Documentation

Connector Management

Connector Management API

Get details of a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": "true"
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "waitingForApproval",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Edit a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Connector UUID

Request Body schema: application/json
required

url	string URL of the Connector to connect
authType	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provicer:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": "true"
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "waitingForApproval",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Delete a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Reconnect to a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

[{"functionGroup": {"functionGroupCode": "credentialProvider",
"kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": "true"
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
}
]

Approve a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Reconnect multiple Connectors

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Connect to a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

url required	string URL of the Connector to connect
uuid	string UUID of the Connector. Mandatory if connection is needed for the same Connector
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE

Responses

Request samples

Payload

Content type

application/json

{"url": "http://network-discovery-provicer:8080",
"uuid": "string",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

[{"functionGroup": {"functionGroupCode": "credentialProvider",
"kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": "true"
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
}
]

Approve multiple Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

400
403
404
502
503

Content type

application/json

{"message": "Error message"
}

List Connectors by Function Group and Kind

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

functionGroup	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "cryptographyProvider" "notificationProvider"
kind	string
status	string (ConnectorStatus) Enum: "waitingForApproval" "connected" "failed" "offline"

Responses

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"functionGroups": [{"functionGroupCode": "credentialProvider",
"kinds": "[\"SoftKeyStore\", \"Basic\", \"ApiKey\"]",
"endPoints": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"context": "/v1",
"method": "POST",
"required": "true"
}
],
"uuid": "204a57f6-2ed3-45b6-bf09-af8b8c900e33",
"name": "string"
}
],
"url": "http://network-discovery-provider:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "waitingForApproval",
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}
]

Create a new Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the Connector
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"url": "http://network-discovery-provicer:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

Content type

application/json

{"uuid": "string"
}

Delete multiple Connectors

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Validate Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string Connector UUID
functionGroup required	string Function Group name
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" Content Type of the Attribute
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
403
404
502
503

Content type

application/json

{"message": "Error message"
}

Check Health of a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

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

Get attributes of all Function Groups

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Connector UUID

Responses

Response samples

Content type

application/json

{"property1": {"property1": [{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"property2": [{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]
},
"property2": {"property1": [{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
],
"property2": [{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]
}
}

Get Attributes from a Connector

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string Connector UUID
functionGroup required	string (FunctionGroupCode) Enum: "credentialProvider" "legacyAuthorityProvider" "authorityProvider" "discoveryProvider" "entityProvider" "complianceProvider" "cryptographyProvider" "notificationProvider" Function Group name
kind required	string Kind

Responses

Response samples

Content type

application/json

[{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Force Delete multiple Connectors

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

Connector UUIDs

Array

string

Responses

Request samples

Payload

Content type

application/json

["c2f685d4-6a3e-11ec-90d6-0242ac120003",
"b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]

Response samples

Content type

application/json

[{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"message": "Object is associated with other items"
}
]

Connector Authentication

Connector Authentication API

Validate JWT auth Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

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" Content Type of the Attribute
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
403
404

Content type

application/json

{"message": "Error message"
}

Validate certificate auth Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

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" Content Type of the Attribute
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
403
404

Content type

application/json

{"message": "Error message"
}

Validate basic auth Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

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" Content Type of the Attribute
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
403
404

Content type

application/json

{"message": "Error message"
}

Validate API Key Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

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" Content Type of the Attribute
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
403
404

Content type

application/json

{"message": "Error message"
}

Get list of Authentication Types

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

200
400
403
404

Content type

application/json

["string"
]

Get JWT auth Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get Attributes for certificate auth

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get basic auth Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Get API Key auth Attributes

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

200
400
403
404

Content type

application/json

[{"version": "2",
"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",
"required": "false",
"readOnly": "false",
"list": "false",
"multiSelect": "false"
},
"constraints": [{"description": "string",
"type": "regExp",
"errorMessage": "string",
"data": "string"
}
],
"attributeCallback": {"callbackContext": "string",
"callbackMethod": "string",
"mappings": [{"from": "string",
"attributeType": "data",
"attributeContentType": "string",
"to": "string",
"targets": ["pathVariable"
],
"value": { }
}
]
}
}
]

Connector Registration

Connector Registration API

Register a Connector

Request Body schema: application/json
required

name required	string Name of the Connector
url required	string URL of the Connector to connect
authType required	string (AuthType) Enum: "none" "basic" "certificate" "apiKey" "jwt" Type of authentication for the Connector
	Array of objects (RequestAttributeDto) List of authentication Attributes. Required if the authentication type is not NONE
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"name": "Connector1",
"url": "http://network-discovery-provicer:8080",
"authType": "none",
"authAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
]
}

Response samples

200
400
404

Content type

application/json

{"uuid": "string"
}

Callback

Callback API

Resource Callback API

API to trigger the Callback for resource.

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

resource

required

string (Resource)

Enum: "NONE" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "notificationInstances" "users" "roles" "acmeAccounts" "acmeProfiles" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders"

Name of the resource

parentObjectUuid

required

string

Parent Object UUID

Request Body schema: application/json
required

uuid	string UUID of the Attribute
name required	string Name of the Attribute
	object Map of path variables supported by the callback method
	object Map of the query parameters supported by the callback method
	object Request body for the callback method

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"pathVariable": {"property1": { },
"property2": { }
},
"requestParameter": {"property1": { },
"property2": { }
},
"body": {"property1": { },
"property2": { }
}
}

Response samples

Content type

application/json

{ }

Connector Callback API

API to trigger the Callback for Connector.

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string Connector UUID
functionGroup required	string Function Group
kind required	string Kind

Request Body schema: application/json
required

uuid	string UUID of the Attribute
name required	string Name of the Attribute
	object Map of path variables supported by the callback method
	object Map of the query parameters supported by the callback method
	object Request body for the callback method

Responses

Request samples

Payload

Content type

application/json

{"uuid": "string",
"name": "string",
"pathVariable": {"property1": { },
"property2": { }
},
"requestParameter": {"property1": { },
"property2": { }
},
"body": {"property1": { },
"property2": { }
}
}

Response samples

Content type

application/json

{ }

CZERTAINLY Connector API (2.14.1)

Connector Management

Get details of a Connector

Authorizations:

path Parameters

Responses

Response samples

Edit a Connector

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a Connector

Authorizations:

path Parameters

Responses

Response samples

Reconnect to a Connector

Authorizations:

path Parameters

Responses

Response samples

Approve a Connector

Authorizations:

path Parameters

Responses

Response samples

Reconnect multiple Connectors

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Connect to a Connector

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Approve multiple Connector

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Connectors by Function Group and Kind

Authorizations:

query Parameters

Responses

Response samples

Create a new Connector

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete multiple Connectors

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate Attributes

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Check Health of a Connector

Authorizations:

path Parameters

Responses

Response samples

Get attributes of all Function Groups

Authorizations:

path Parameters

Responses

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