CZERTAINLY Token Management API (2.13.0)
Download OpenAPI specification:Download
REST API for managing tokens in the platform
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Update Token Instance
path Parameters
uuid required | string Token Instance UUID |
Request Body schema: application/jsonrequired
name required | string Name of the Token Instance |
description | string Token Instance description |
connectorUuid required | string UUID of the Connector |
kind required | string Connector Kind |
required | Array of objects (RequestAttributeDto) Custom Attributes |
required | Array of objects (RequestAttributeDto) Attributes for Token Instance |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "connectorUuid": "string",
- "kind": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Response samples
- 200
- 400
- 403
- 404
- 422
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Create a new Token Instance
Request Body schema: application/jsonrequired
name required | string Name of the Token Instance |
description | string Token Instance description |
connectorUuid required | string UUID of the Connector |
kind required | string Connector Kind |
required | Array of objects (RequestAttributeDto) Custom Attributes |
required | Array of objects (RequestAttributeDto) Attributes for Token Instance |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "connectorUuid": "string",
- "kind": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Response samples
- 201
- 400
- 403
- 404
- 422
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "connectorName": "string",
- "connectorUuid": "string",
- "kind": "string",
- "status": {
- "status": "Connected",
- "components": {
- "property1": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "status": "Connected",
- "details": {
- "property1": { },
- "property2": { }
}
}
}
}, - "tokenProfiles": 0,
- "attributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "sourceObjectType": "NONE",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Activate Token Instance
path Parameters
uuid required | string Token Instance UUID |
Request Body schema: application/jsonrequired
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
- 403
- 404
Content type
application/json
{- "message": "Error message"
}
Response samples
- 200
- 400
- 403
- 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": { }
}
]
}
}
]
Response samples
- 200
- 400
- 403
- 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": { }
}
]
}
}
]
deleteTokenInstance_1
Delete multiple Token Instance
Request Body schema: application/jsonrequired
Token Instance 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
Content type
application/json
{- "message": "Error message"
}