Secret Management API (2.17.0)

Download OpenAPI specification:Download

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for managing secrets in the platform

ILM Documentation

Secret Management

APIs for managing secrets, including creation, retrieval, updating, and deletion of secrets.

Get secret details

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

UUID of the secret

Responses

Response samples

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"type": "basicAuth",
"description": "string",
"sourceVaultProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"state": "inactive",
"version": 0,
"enabled": true,
"owner": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"complianceStatus": "not_checked",
"syncVaultProfiles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"secretAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"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"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Update an existing secret

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

UUID of the secret

Request Body schema: application/json
required

description required	string Description of the secret
	BasicAuthSecretContent (object) or ApiKeySecretContent (object) or JwtTokenSecretContent (object) or PrivateKeySecretContent (object) or SecretKeySecretContent (object) or KeyStoreSecretContent (object) or KeyValueSecretContent (object) or GenericSecretContent (object) (SecretContent)
required	Array of objects (RequestAttribute) List of attributes associated with the secret
	Array of objects (RequestAttribute) List of custom attributes associated with the secret

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"secret": {"type": "basicAuth",
"username": "admin",
"password": "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

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"type": "basicAuth",
"description": "string",
"sourceVaultProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"state": "inactive",
"version": 0,
"enabled": true,
"owner": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"complianceStatus": "not_checked",
"syncVaultProfiles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"secretAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"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"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

Delete a secret

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

UUID of the secret

Responses

Update Secret Objects

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Secret UUID

Request Body schema: application/json
required

sourceVaultProfileUuid	string <uuid> UUID of the vault profile where the secret is stored
	Array of objects (RequestAttribute) Secret attributes, to be provided if new source vault profile is assigned to a different vault then the original source vault profile
groupUuids	Array of strings <uuid> unique [ items <uuid > ] Secret Groups UUIDs (set to empty array [] to remove secrets from all groups)
ownerUuid	string Secret owner user UUID (set to empty string to remove owner of the secret)

Responses

Request samples

Payload

Content type

application/json

{"sourceVaultProfileUuid": "39ca1c29-2e46-449a-a618-7b63991d614c",
"secretAttributes": [{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
],
"groupUuids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"ownerUuid": "string"
}

Create a new secret

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

vaultProfileUuid required	string <uuid> UUID of vault profile
vaultUuid required	string <uuid> UUID of vault instance

Request Body schema: application/json
required

name required	string non-empty Name of the secret
description required	string Description of the secret
required	BasicAuthSecretContent (object) or ApiKeySecretContent (object) or JwtTokenSecretContent (object) or PrivateKeySecretContent (object) or SecretKeySecretContent (object) or KeyStoreSecretContent (object) or KeyValueSecretContent (object) or GenericSecretContent (object) (SecretContent)
required	Array of objects (RequestAttribute) List of attributes associated with the secret
	Array of objects (RequestAttribute) List of custom attributes associated with the secret

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"secret": {"type": "basicAuth",
"username": "admin",
"password": "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

Content type

application/json

{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"type": "basicAuth",
"description": "string",
"sourceVaultProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"state": "inactive",
"version": 0,
"enabled": true,
"owner": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"complianceStatus": "not_checked",
"syncVaultProfiles": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"secretAttributes": [{"content": [{"reference": "string",
"data": true
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"version": "v2"
}
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"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"
}
],
"metadata": [{"connectorUuid": "string",
"connectorName": "string",
"sourceObjectType": "NONE",
"items": [{"sourceObjects": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"label": "Attribute Name",
"type": "data",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]
}
]
}

List secrets

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

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": null
}
],
"itemsPerPage": 10,
"pageNumber": 1
}

Response samples

Content type

application/json

{"items": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name",
"type": "basicAuth",
"description": "string",
"sourceVaultProfile": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"state": "inactive",
"version": 0,
"enabled": true,
"owner": {"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
},
"groups": [{"uuid": "7b55ge1c-844f-11dc-a8a3-0242ac120002",
"name": "Name"
}
],
"complianceStatus": "not_checked"
}
],
"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0
}

Remove vault profile from secret

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string <uuid> UUID of the secret
vaultProfileUuid required	string <uuid> UUID of the vault profile

Responses

Add vault profile to secret

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string <uuid> UUID of the secret
vaultProfileUuid required	string <uuid> UUID of the vault profile

Request Body schema: application/json
required

Array

uuid required	string <uuid> 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" "resource" Content Type of the Attribute
	Array of 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) (BaseAttributeContentDtoV2)
version required	string (AttributeVersion) Version of the Attribute v2

Responses

Request samples

Payload

Content type

application/json

[{"uuid": "b11c9be1-b619-4ef5-be1b-a1cd9ef265b7",
"name": "Attribute",
"contentType": "string",
"content": [{"reference": "string",
"data": true,
"contentType": "string"
}
],
"version": "v2"
}
]

Enable a secret

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

UUID of the secret

Responses

Disable a secret

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

UUID of the secret

Responses

Get secret versions

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

UUID of the secret

Responses

Response samples

Content type

application/json

[{"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"fingerprint": "string"
}
]

Get secret content

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

UUID of the secret

Responses

Response samples

Content type

application/json

Example

basicAuth

{"type": "basicAuth",
"username": "admin",
"password": "string"
}

List search filters for secrets

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Responses

Response samples

Content type

application/json

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

Secret Management API (2.17.0)

Secret Management

Get secret details

Authorizations:

path Parameters

Responses

Response samples

Update an existing secret

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a secret

Authorizations:

path Parameters

Responses

Update Secret Objects

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Create a new secret

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

List secrets

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove vault profile from secret

Authorizations:

path Parameters

Responses

Add vault profile to secret

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Enable a secret

Authorizations:

path Parameters

Responses

Disable a secret

Authorizations:

path Parameters

Responses

Get secret versions

Authorizations:

path Parameters

Responses

Response samples

Get secret content

Authorizations:

path Parameters

Responses

Response samples

List search filters for secrets

Authorizations:

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

Request Body schema: application/json
required