CZERTAINLY Certificate API (2.7.1)
Download OpenAPI specification:Download
REST API for managing Certificates in the platform
List Certificates
Request Body schema: application/json
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
{- "filters": [
- {
- "groupName": "string",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
], - "itemsPerPage": 10,
- "pageNumber": 1
}
Response samples
- 200
- 400
- 403
- 404
{- "certificates": [
- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "status": "valid",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "group": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}, - "owner": "string",
- "certificateType": "X509",
- "issuerSerialNumber": "string",
- "complianceStatus": "ok",
- "privateKeyAvailability": true
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}
Update RA Profile, Group, Owner for multiple Certificates
In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body
Request Body schema: application/json
raProfileUuid | string UUID of the RA Profile |
groupUuid | string UUID of the Certificate Group |
owner | string Certificate Owner |
certificateUuids | Array of strings List of Certificate UUIDs |
Array of objects (SearchFilterRequestDto) Certificate filter input |
Responses
Request samples
- Payload
{- "raProfileUuid": "string",
- "groupUuid": "string",
- "owner": "string",
- "certificateUuids": [
- "string"
], - "filters": [
- {
- "groupName": "string",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]
}
Response samples
- 400
- 403
- 404
{- "message": "Error message"
}
Upload a new Certificate
Request Body schema: application/json
certificate required | string Base64 Content of the Certificate |
required | Array of objects (RequestAttributeDto) Custom Attributes for the Certificate |
Responses
Request samples
- Payload
{- "certificate": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Response samples
- 201
- 400
- 403
- 404
{- "uuid": "string"
}
Delete multiple certificates
In this operation, when the list of Certificate UUIDs are provided and the filter is left as null or undefined, then the change will be applied only to the list of Certificate UUIDs provided. When the filter is provided in the request, the list of UUIDs will be ignored and the change will be applied for the all the certificates that matches the filter criteria. To apply this change for all the Certificates in the inventory, provide an empty array "[]" for the value of "filters" in the request body
Request Body schema: application/json
uuids | Array of strings List of Certificate UUIDs |
Array of objects (SearchFilterRequestDto) Certificate filter input |
Responses
Request samples
- Payload
{- "uuids": [
- "string"
], - "filters": [
- {
- "groupName": "string",
- "fieldIdentifier": "string",
- "condition": "EQUALS",
- "value": { }
}
]
}
Response samples
- 200
- 400
- 403
- 404
{- "status": "SUCCESS",
- "failedItem": 0,
- "message": "string"
}
Generate CSR Entity
Request Body schema: application/json
Array of objects (RequestAttributeDto) List of attributes to create CSR. Required if CSR is not provided | |
Array of objects (RequestAttributeDto) List of attributes to sign the CSR | |
pkcs10 required | string Certificate sign request (PKCS#10) encoded as Base64 string |
tokenProfileUuid | string <uuid> Token Profile UUID. Required if CSR is not uploaded |
keyUuid | string <uuid> Key UUID. Required if CSR is not uploaded |
Array of objects (RequestAttributeDto) List of Custom Attributes |
Responses
Request samples
- Payload
{- "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "pkcs10": "string",
- "tokenProfileUuid": "66f2e24c-4f07-496b-b5c4-6fe8a5e8361a",
- "keyUuid": "a0e39a6c-fae3-43d6-99c3-a3620775a368",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}
Response samples
- 200
- 400
- 403
- 404
{- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "status": "valid",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "group": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}, - "owner": "string",
- "certificateType": "X509",
- "issuerSerialNumber": "string",
- "complianceStatus": "ok",
- "privateKeyAvailability": true,
- "extendedKeyUsage": [
- "string"
], - "keyUsage": [
- "string"
], - "basicConstraints": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjectType": "string",
- "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "certificateContent": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "locations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "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
}
]
}
], - "enabled": true,
- "supportMultipleEntries": false,
- "supportKeyManagement": false,
- "certificates": [
- {
- "certificateUuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
], - "sourceObjectType": "string",
- "sourceObjects": [
- null
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": false
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjectType": "string",
- "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}
], - "nonCompliantRules": [
- {
- "connectorName": "Provider1",
- "ruleName": "RuleName",
- "ruleDescription": "Description sample",
- "status": "nok",
- "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
}
]
}
], - "csr": "string",
- "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "key": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "group": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}, - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "group": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}, - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret key",
- "cryptographicAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "associations": 0
}
}
Get Certificate Content
Request Body schema: application/json
Certificate UUIDs
Responses
Request samples
- Payload
[- "c2f685d4-6a3e-11ec-90d6-0242ac120003",
- "b9b09548-a97c-4c6a-a06a-e4ee6fc2da98"
]
Response samples
- 200
- 400
- 403
- 404
- 422
[- {
- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "certificateContent": "string"
}
]
Initiate Certificate Compliance Check
Request Body schema: application/json
certificateUuids | Array of strings List of UUIDs of the Certificates |
Responses
Request samples
- Payload
{- "certificateUuids": [
- "string"
]
}
Response samples
- 400
- 403
- 404
{- "message": "Error message"
}
Response samples
- 200
- 400
- 403
- 404
{- "uuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "issuerCommonName": "string",
- "issuerDn": "string",
- "subjectDn": "string",
- "notBefore": "2019-08-24T14:15:22Z",
- "notAfter": "2019-08-24T14:15:22Z",
- "publicKeyAlgorithm": "string",
- "signatureAlgorithm": "string",
- "keySize": 0,
- "status": "valid",
- "raProfile": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "enabled": true,
- "authorityInstanceUuid": "string"
}, - "fingerprint": "string",
- "group": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}, - "owner": "string",
- "certificateType": "X509",
- "issuerSerialNumber": "string",
- "complianceStatus": "ok",
- "privateKeyAvailability": true,
- "extendedKeyUsage": [
- "string"
], - "keyUsage": [
- "string"
], - "basicConstraints": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjectType": "string",
- "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
], - "certificateContent": "string",
- "subjectAlternativeNames": {
- "property1": { },
- "property2": { }
}, - "locations": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "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
}
]
}
], - "enabled": true,
- "supportMultipleEntries": false,
- "supportKeyManagement": false,
- "certificates": [
- {
- "certificateUuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- null
], - "sourceObjectType": "string",
- "sourceObjects": [
- null
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": false
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjectType": "string",
- "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}
], - "nonCompliantRules": [
- {
- "connectorName": "Provider1",
- "ruleName": "RuleName",
- "ruleDescription": "Description sample",
- "status": "nok",
- "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
}
]
}
], - "csr": "string",
- "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "signatureAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "key": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "group": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}, - "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "creationTime": "2019-08-24T14:15:22Z",
- "keyWrapperUuid": "string",
- "tokenProfileUuid": "string",
- "tokenProfileName": "string",
- "tokenInstanceUuid": "string",
- "tokenInstanceName": "string",
- "owner": "string",
- "group": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "customAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
]
}, - "associations": 0,
- "keyReferenceUuid": "string",
- "type": "Secret key",
- "cryptographicAlgorithm": "RSA",
- "format": "Raw",
- "length": 0,
- "usage": [
- "sign"
], - "enabled": true,
- "state": "pre-active"
}
], - "associations": 0
}
}
Update Certificate Objects
path Parameters
uuid required | string Certificate UUID |
Request Body schema: application/json
raProfileUuid | string RA Profile UUID |
groupUuid | string Group UUID |
owner | string Certificate Owner |
Responses
Request samples
- Payload
{- "raProfileUuid": "string",
- "groupUuid": "string",
- "owner": "string"
}
Response samples
- 400
- 403
- 404
{- "message": "Error message"
}
Response samples
- 200
- 400
- 403
- 404
[- {
- "uuid": "string",
- "certificateUuid": "string",
- "created": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "event": "Issue Certificate",
- "status": "SUCCESS",
- "message": "string",
- "additionalInformation": {
- "property1": { },
- "property2": { }
}
}
]
List of available Locations for the Certificate
path Parameters
certificateUuid required | string Certificate UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
[- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "entityInstanceUuid": "string",
- "entityInstanceName": "string",
- "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
}
]
}
], - "enabled": true,
- "supportMultipleEntries": false,
- "supportKeyManagement": false,
- "certificates": [
- {
- "certificateUuid": "string",
- "commonName": "string",
- "serialNumber": "string",
- "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": null,
- "data": null
}
], - "sourceObjectType": "string",
- "sourceObjects": [
- {
- "uuid": null,
- "name": null
}
]
}
]
}
], - "pushAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "csrAttributes": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
]
}
], - "withKey": false
}
], - "metadata": [
- {
- "connectorUuid": "string",
- "connectorName": "string",
- "items": [
- {
- "uuid": "166b5cf52-63f2-11ec-90d6-0242ac120003",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "sourceObjectType": "string",
- "sourceObjects": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}
]
}
]
}
]
}
]
Response samples
- 200
- 400
- 403
- 404
[- {
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "value": { },
- "multiValue": true,
- "field": "commonName"
}
], - "groupName": "string"
}
]
Response samples
- 200
- 400
- 403
- 404
[- {
- "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": { }
}
]
}
}
]