Vault API (2.17.0)
Download OpenAPI specification:Download
REST API for managing Vaults in the platform
Details of a Vault instance
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string <uuid> Vault instance UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connector": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}, - "connectorInterface": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "code": "info",
- "version": "string",
- "features": [
- "stateless"
]
}, - "attributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]
}Update a Vault instance
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string <uuid> Vault instance UUID |
Request Body schema: application/jsonrequired
| description | string Description of the Vault instance |
required | Array of objects (RequestAttribute) List of attributes of the Vault instance |
Array of objects (RequestAttribute) List of custom attributes of the Vault instance |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "string",
- "attributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "customAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
]
}Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connector": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}, - "connectorInterface": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "code": "info",
- "version": "string",
- "features": [
- "stateless"
]
}, - "attributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]
}Create a Vault instance
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
| connectorUuid required | string <uuid> UUID of the Connector associated with this Vault instance |
| interfaceUuid required | string <uuid> UUID of the Connector Interface associated with this Vault instance |
| name required | string Name of the Vault instance |
| description | string Description of the Vault instance |
required | Array of objects (RequestAttribute) List of attributes of the Vault instance |
Array of objects (RequestAttribute) List of custom attributes of the Vault instance |
Responses
Request samples
- Payload
Content type
application/json
{- "connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
- "interfaceUuid": "b2f9cd76-da41-40e8-99bf-3aed86d08788",
- "name": "string",
- "description": "string",
- "attributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
], - "customAttributes": [
- {
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "contentType": "string",
- "content": [
- {
- "reference": "string",
- "data": true,
- "contentType": "string"
}
], - "version": "v2"
}
]
}Response samples
- 201
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connector": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}, - "connectorInterface": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "code": "info",
- "version": "string",
- "features": [
- "stateless"
]
}, - "attributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
], - "customAttributes": [
- {
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "name": "Attribute",
- "label": "Attribute Name",
- "type": "data",
- "contentType": "string",
- "version": "v2"
}
]
}List Vault instances
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Request Body schema: application/jsonrequired
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": null
}
], - "itemsPerPage": 10,
- "pageNumber": 1
}Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
{- "items": [
- {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name",
- "description": "string",
- "connector": {
- "uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
- "name": "Name"
}, - "connectorInterface": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "code": "info",
- "version": "string",
- "features": [
- "stateless"
]
}
}
], - "itemsPerPage": 0,
- "pageNumber": 0,
- "totalPages": 0,
- "totalItems": 0
}List Vault Profile Attributes
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| uuid required | string <uuid> Vault instance UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
[- {
- "name": "Attribute",
- "type": "data",
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "description": "string",
- "version": 0,
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes",
- "required": false,
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "protectionLevel": "none",
- "resource": "certificates",
- "extensibleList": false
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": null
}
]
}
}
]List Vault Instance Attributes
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
path Parameters
| connectorUuid required | string <uuid> Connector UUID |
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
[- {
- "name": "Attribute",
- "type": "data",
- "uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
- "description": "string",
- "version": 0,
- "content": [
- {
- "reference": "string",
- "data": true
}
], - "contentType": "string",
- "properties": {
- "label": "Attribute Name",
- "visible": true,
- "group": "requiredAttributes",
- "required": false,
- "readOnly": false,
- "list": false,
- "multiSelect": false,
- "protectionLevel": "none",
- "resource": "certificates",
- "extensibleList": false
}, - "constraints": [
- {
- "type": "regExp",
- "errorMessage": "string",
- "description": "string",
- "data": "string"
}
], - "attributeCallback": {
- "callbackContext": "string",
- "callbackMethod": "string",
- "mappings": [
- {
- "from": "string",
- "attributeType": "data",
- "attributeContentType": "string",
- "to": "string",
- "targets": [
- "pathVariable"
], - "value": null
}
]
}
}
]List search filters for Vault instances
Authorizations:
BearerJWTAuthCertificateAuthSessionAuth
Responses
Response samples
- 200
- 400
- 403
- 404
- 502
- 503
Content type
application/json
[- {
- "filterFieldSource": "meta",
- "searchFieldData": [
- {
- "fieldIdentifier": "string",
- "fieldLabel": "string",
- "type": "string",
- "conditions": [
- "EQUALS"
], - "platformEnum": "Resource",
- "attributeContentType": "string",
- "value": null,
- "multiValue": true
}
]
}
]