Secrets API
| Action | Endpoint |
|---|---|
| Fetch a Secret | GET/resource/{tenantLocator}/secrets/{name} |
| Create a Secret | POST/resource/{tenantLocator}/secrets |
| Update a Secret | PATCH/resource/{tenantLocator}/secrets/{name} |
| Delete Secret | DELETE/resource/{tenantLocator}/secrets/{name} |
Fetch a Secret
Fetch a Secret
fetchSecretGET
/resource/{tenantLocator}/secrets/{name}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
name | path | string | Yes | |
byStaticName | query | boolean? | No | |
date | query | datetime? | No | |
jurisdiction | query | string? | No |
Response:
SecretResponseSecurity Group:
secretsPermission:
readSecretResponse
Required properties
| Property | Type | Description |
|---|---|---|
resource | BasicResourceResponse | |
secret | object |
Create a Secret
Create a Secret
createSecretPOST
/resource/{tenantLocator}/secretsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
SecretCreateRequest
Required properties
| Property | Type | Description |
|---|---|---|
staticName | string | |
name | string | |
jurisdictions | string[] | |
secret | map<string, object> |
Update a Secret
Update a Secret
updateSecretPATCH
/resource/{tenantLocator}/secrets/{name}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
name | path | string | Yes |
Delete Secret
Delete Secret
deleteSecretDELETE
/resource/{tenantLocator}/secrets/{name}Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
name | path | string | Yes |
Response:
voidSecurity Group:
secretsPermission:
write