CZERTAINLY Entity API (2.13.1)

Download OpenAPI specification:Download

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

REST API for managing Entities in the platform

CZERTAINLY Documentation

Entity Management

Entity Management API

Get Entity instance details

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Response samples

200
400
404
502
503

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}

Edit Entity instance

path Parameters

entityUuid

required

string

Entity instance UUID

Request Body schema: application/json
required

required	Array of objects (RequestAttributeDto) List of Entity instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes

Responses

Request samples

Payload

Content type

application/json

{"attributes": [{"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",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}

Delete Entity instance

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Add Entity instance

Request Body schema: application/json
required

name required	string Entity instance name
required	Array of objects (RequestAttributeDto) List of Entity instance Attributes
	Array of objects (RequestAttributeDto) List of Custom Attributes
connectorUuid required	string UUID of Entity Provider
kind required	string Entity instance Kind

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"attributes": [{"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
}
]
}
],
"connectorUuid": "string",
"kind": "Keystore, etc."
}

Response samples

Content type

application/json

{"uuid": "string"
}

Validate Location Attributes

path Parameters

entityUuid

required

string

Entity instance UUID

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

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

List Entity instances

Request Body schema: application/json
required

	Array of objects (SearchFilterRequestDto) Certificate filter input
itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Request samples

Payload

Content type

application/json

{"filters": [{"fieldSource": "meta",
"fieldIdentifier": "string",
"condition": "EQUALS",
"value": { }
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

200
400
404
502
503

Content type

application/json

{"entities": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"attributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"customAttributes": [{"uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true
}
]
}
],
"status": "string",
"connectorUuid": "string",
"connectorName": "string",
"kind": "Keystore, etc."
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

List Location Attributes

path Parameters

entityUuid

required

string

Entity instance UUID

Responses

Response samples

200
400
404
502
503

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": { }
}
]
}
}
]

Get Entities searchable fields information

Responses

Response samples

200
400
404
502
503

Content type

application/json

[{"filterFieldSource": "meta",
"searchFieldData": [{"fieldIdentifier": "string",
"fieldLabel": "string",
"type": "string",
"conditions": ["EQUALS"
],
"platformEnum": "Resource",
"attributeContentType": "string",
"value": { },
"multiValue": true
}
]
}
]

CZERTAINLY Entity API (2.13.1)

Entity Management

Get Entity instance details

path Parameters

Responses

Response samples

Edit Entity instance

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Entity instance

path Parameters

Responses

Add Entity instance

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate Location Attributes

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Entity instances

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List Location Attributes

path Parameters

Responses

Response samples

Get Entities searchable fields information

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required