Attribute API (2.17.0)
Download OpenAPI specification:Download
REST API for managing Custom attributes and global metadata in the platform
Custom Attribute details
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "protectionLevel": "none",
- "version": "v2",
- "type": "data",
- "label": "Attribute Name",
- "required": true,
- "visible": true,
- "group": "requiredAttributes",
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "resources": [
- "NONE"
], - "extensibleList": true
}Edit Custom Attribute
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string Attribute UUID |
Request Body schema: application/jsonrequired
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
| required | boolean Default: false Boolean determining if the Attribute is required. If true, the Attribute must be provided. |
| readOnly | boolean Default: false Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed. |
| list | boolean Default: false Boolean determining if the Attribute contains list of values in the content |
| multiSelect | boolean Default: false Boolean determining if the Attribute can have multiple values |
| protectionLevel | string (ProtectionLevel) Enum: "none" "encrypted" Protection level of the attribute |
Array of (BaseAttributeContentDtoV2 (BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object))) or BaseAttributeContentDtoV3 (object) (AttributeContent) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type | |
| resources | Array of strings (Resource) Items Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" List of resource to be associated with the custom attribute |
| extensibleList | boolean Default: false Boolean determining if a list Attribute can have values other than predefined options |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "string",
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes",
- "required": false,
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "protectionLevel": "none",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "resources": [
- "NONE"
], - "extensibleList": false
}Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "protectionLevel": "none",
- "version": "v2",
- "type": "data",
- "label": "Attribute Name",
- "required": true,
- "visible": true,
- "group": "requiredAttributes",
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "resources": [
- "NONE"
], - "extensibleList": true
}List Custom Attributes
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
query Parameters
| attributeContentType | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" |
Responses
Response samples
- 200
- 400
- 403
Content type
application/json
[- {
- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "protectionLevel": "none",
- "version": "v2",
- "resources": [
- "NONE"
]
}
]Create Custom Attribute
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
| 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" "resource" Attribute Content Type |
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
| required | boolean Default: false Boolean determining if the Attribute is required. If true, the Attribute must be provided. |
| readOnly | boolean Default: false Boolean determining if the Attribute is read only. If true, the Attribute content cannot be changed. |
| list | boolean Default: false Boolean determining if the Attribute contains list of values in the content |
| multiSelect | boolean Default: false Boolean determining if the Attribute can have multiple values |
| extensibleList | boolean Default: false Boolean determining if a list Attribute can have values other than predefined options |
Array of (BaseAttributeContentDtoV2 (BooleanAttributeContentV2 (object) or CodeBlockAttributeContentV2 (object) or CredentialAttributeContentV2 (object) or DateAttributeContentV2 (object) or DateTimeAttributeContentV2 (object) or FileAttributeContentV2 (object) or FloatAttributeContentV2 (object) or IntegerAttributeContentV2 (object) or ObjectAttributeContentV2 (object) or SecretAttributeContentV2 (object) or StringAttributeContentV2 (object) or TextAttributeContentV2 (object) or TimeAttributeContentV2 (object))) or BaseAttributeContentDtoV3 (object) (AttributeContent) Predefined content for the attribute if needed. The content of the Attribute must satisfy the type | |
| protectionLevel | string (ProtectionLevel) Enum: "none" "encrypted" Protection level of the attribute |
| resources | Array of strings (Resource) Items Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" List of resource to be associated with the custom attribute |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "contentType": "string",
- "description": "string",
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes",
- "required": false,
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "extensibleList": false,
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "protectionLevel": "none",
- "resources": [
- "NONE"
]
}Response samples
- 201
- 400
- 403
Content type
application/json
{- "uuid": "string"
}Delete multiple Custom Attributes
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Attribute 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
Content type
application/json
{- "message": "Error message"
}Associate Custom Attribute to Resource
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string <uuid> Custom Attribute UUID |
Request Body schema: application/jsonrequired
List of Resources
Array
string
Responses
Request samples
- Payload
Content type
application/json
[- "raProfiles",
- "authorities"
]Response samples
- 400
- 403
- 404
Content type
application/json
{- "message": "Error message"
}Delete Value of a Custom Attribute for a Resource
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| resourceName required | string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource Type |
| objectUuid required | string Object UUID |
| attributeUuid required | string Custom Attribute UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
[- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]Update Value of a Custom Attribute for a Resource
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| resourceName required | string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource Type |
| objectUuid required | string Object UUID |
| attributeUuid required | string Custom Attribute UUID |
Request Body schema: application/jsonrequired
Array
One of
One of
| reference | string ContentV2 Reference |
| data required | boolean Boolean attribute value |
| contentType | string (AttributeContentType) Enum: "string" "text" "integer" "boolean" "float" "date" "time" "datetime" "secret" "file" "credential" "codeblock" "object" "resource" |
Responses
Request samples
- Payload
Content type
application/json
[- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
]Response samples
- 200
- 400
- 403
- 404
Content type
application/json
[- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]Enable multiple Custom Attributes
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Attribute 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
Content type
application/json
{- "message": "Error message"
}Disable multiple Custom Attributes
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Attribute 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
Content type
application/json
{- "message": "Error message"
}Get Custom Attributes for a resource
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| resource required | string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Resource Name |
Responses
Response samples
- 200
- 400
- 403
Content type
application/json
[- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "description": "string",
- "version": 0,
- "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,
- "extensibleList": false,
- "protectionLevel": "none"
}
}
]Global Metadata details
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string |
Responses
Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "protectionLevel": "none",
- "version": "v2",
- "type": "data",
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes"
}Edit Global Metadata
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string Global Metadata UUID |
Request Body schema: application/jsonrequired
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "string",
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes"
}Response samples
- 200
- 400
- 403
- 404
Content type
application/json
{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "protectionLevel": "none",
- "version": "v2",
- "type": "data",
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes"
}Create Global Metadata
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
| 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" "resource" Attribute Content Type |
| description | string Attribute description |
| label required | string Friendly name of the the Attribute |
| visible | boolean Default: true Boolean determining if the Attribute is visible and can be displayed, otherwise it should be hidden to the user. |
| group | string Group of the Attribute, used for the logical grouping of the Attribute |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "contentType": "string",
- "description": "string",
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes"
}Response samples
- 201
- 400
- 403
Content type
application/json
{- "uuid": "string"
}Delete multiple Global Metadata
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
Global Metadata 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
Content type
application/json
{- "message": "Error message"
}Promote Connector Metadata to Global Metadata
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
| uuid required | string Metadata UUID |
| connectorUuid required | string Connector UUID |
Responses
Request samples
- Payload
Content type
application/json
{- "uuid": "string",
- "connectorUuid": "string"
}Response samples
- 204
- 400
- 403
- 404
Content type
application/json
{- "uuid": "string",
- "name": "string",
- "contentType": "string",
- "description": "string",
- "enabled": true,
- "protectionLevel": "none",
- "version": "v2",
- "type": "data",
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes"
}