Secrets Manager API

Delete organization deleteOrganization

DELETE

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Deletes the organization

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Successful. Returns zero length body.

Delete environment deleteEnvironment

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Deletes the environment

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Response

Successful. Returns zero length body.

List operation statuses listOperations

GET

Try it out

Path Parameters

organizationId *

environmentId *

Query Parameters

type

Custom Query Parameters

Custom Headers

Retrieves a operations.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

type: string

The type query parameter.

Response

json

Give information if a new request can be triggered or not for specific operation.

items: array

Array items

Examples

application/json

[ { "type": "clone", "canInitiateARequest": true } ]

List secret groups listSecretGroups

GET

Try it out

Path Parameters

organizationId *

environmentId *

Query Parameters

downloadable

Custom Query Parameters

Custom Headers

Get a list of secretGroups.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Query Parameters

downloadable: string

Filter and fetch list of secret groups based on value of 'downloadable' flag.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create secret group createSecretGroup

POST

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new secretGroup.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Request Body

json

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

downloadable: boolean

Setting this to true indicates that the secrets from this secret group are allowed to be downloadable by end users, altough, through other applications.

default: False

Response

json

Resource created successfully.

id *: string

maxLength: 50

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get secret group by ID getSecretGroupById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

Get the secretGroup
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Response

json

Successful operation.

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

downloadable *: boolean

Indicates whether the secrets from this secret group are allowed to be downloadable by end users, altough, through other applications.

meta *: object

Metadata of the secret group

id *: string

Id assigned to this secret group

maxLength: 50

createdAt *: string(date-time-only)

Time at which this secret group was created

modifiedAt *: string(date-time-only)

Time at which this secret group was last modified

modifiedBy *: string

Username of the anypoint platform user who modified this secret group

locked *: boolean

Indicates whether this secret group is currently locked

lockedBy: string

Username of the anypoint platform user who currently holds the lock on this secret group. This is present only if 'locked' is set to true.

currentState *: string

The state the secret group is currently in. If the state is anything but 'Clear', only the corresponding operation is allowed on the secret group, as follows.

If currentState="Finishing", only operation allowed - delete lock with action = finish.
If currentState="Cancelling", only operation allowed - delete lock with action = cancel.
If currentState="Deleting", only operation allowed - delete secret group.

Examples

application/json

{ "name": { "id": "string", "type": "string" }, "downloadable": true, "meta": { "id": "string", "type": "string" } }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update secret group patchSecretGroup

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Operation to update name of this secret group.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

downloadable: boolean

Setting this to true indicates that the secrets from this secret group are allowed to be downloadable by end users, altough, through other applications.

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the currentState of the secret group does not allow this operation.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

message *: string

Human readable error description.

Examples

application/json

{ "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ], "message": "string" }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Delete secret group deleteSecretGroup

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

force

Custom Query Parameters

Custom Headers

Deletes the secret group.

The amount of time required for this operation to complete is proportionate to the number of secrets in the secret group.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

force: boolean

Forcefully delete the secret group even if it contains shared secret(s) of type VDPContext.

Response

Operation completed successfully with no content returned.

state of conflict. It can occur if the currentState of the secret group does not allow this operation or secret group contains a shared secret of type VDPContext.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Acquire secret group lock (deprecated) acquireSecretGroupLock

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

[Deprecated] For compatibility purpose, it always returns successful response.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Response

Response to indicate operation completed successfully.

Release secret group lock (deprecated) releaseSecretGroupLock

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

action *

Custom Query Parameters

Custom Headers

[Deprecated] For compatibility purpose, it always returns successful response.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

action *: string

To indicate how the lock is being released, either as operation 'finish' or 'cancel'.

finish = Indicates that the secret group editing is complete, and all draft changes (including additions) made since acquiring the lock, are to be committed.
cancel = Indicates that the lock needs to be released and all of the draft changes (including additions) made since acquiring the lock should be discarded.

Only the user who acquired the lock can use value 'finish'. Any user, including the user who acquired the lock, can use the value 'cancel'.
The amount of time required for this operation to complete increases, as the the number of secrets that were operated on after acquirirng the lock increases.

Response

Response to indicate operation completed successfully.

Clone secret group cloneSecretGroup

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Request to clone this secret group.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Request Body

json

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

targetEnvId: string

Environment id of target where we want to create new secret group. If not set, by default, it will be set to source env id.

Response

json

Request accepted for processing.

id *: string

Id of newly created secret group.

maxLength: 50

message *: string

Message indicating user to check back after some time

Examples

application/json

{ "message": "Request to clone secret group accepted successfully. Please check the status after some time.", "id": "6b40448d-d122-471b-ae0f-22c59f1b9589" }

Bad request. The request was malformed or contains invalid parameters.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the currentState of the secret group does not allow this operation.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

State of overload. It can occur, if the server does not have capacity to serve new requests.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Cancel secret group clone cancelSecretGroupClone

DELETE

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

To cancel the in-progress clone operation on the secret group, This can be performed on either source or target secret group.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Response

json

Response to indicate cancel clone operation accepted successfully.

message *: string

Message indicating cancel clone request accepted successfully

Examples

application/json

{ "message": "Request to cancel the clone operation accepted successfully. Please check the status after some time." }

Bad request. The request was malformed or contains invalid parameters.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

State of conflict. It can occur if clone operation is not initiated on this secret group.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create secret access grants createSecretGrants

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Returns an access grant for each of the secrets, along with corresponding secret path from the request body

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Request Body

json

paths *: array

Response

json

Successful operation.

items: array

List of access grants

Examples

application/json

[ { "path": "certificates/bc8746e1-23a1-41ad-87f9-fb8b08dc2385", "accessGrant": "QWNjZXNzSWQ9MjM0MzI0aGtmdHJraHV5dWl5JkV4cGlyZXM9MjUzODE1OTUwMCZTaWduYXR1cmU9Qmd5dHk1NjVnaGhqZ2RnZFJUWVJ0eXJibm1ibm1ibW5iWVR1eXR1eXQ1Njc1NiUyQm1XQlBxd2dVWWNPU3N6Q1BsZ1dSRWVGN29QR293a2VLazdnYXNoamdzZGhqZjU2NzU2N3NkZmpoa2p5dWl5ODc2c2RmODc2a2poZWpmaFJUdmdmZ2hUWVJnZ2ZvRGVBR25mekNkNGZUc1djTGJhbDlzRnBxWHNRSThJUWkxNDkzbXclM0Q=" }, { "path": "keystores/fc1579cf-a5ba-486f-925c-d537c22eff54", "accessGrant": "QWNjZXNzSWQ9MjM0MzI0aGtmdHJkZnV5dWl5JkV4cGlyZXM9MjUzODE1OTUwMCZTaWduYXR1cmU9Qmd5dHk1NjVnaGVyZ2RnZFJUWVJ0eXJibm1ibm1ibW5iWVR1eXR1eXQ1Njc1NiUyQm1XQlBxd2dVWWNPU3N6Q1BsZ1dSRWVGN29QR293a2VLazdnYXNoamdzZGhqZjU2NzU2N3NkZmpoa2p5dWl5ODc2c2RmODc2a2poZWpmaFJUdmdmZ2hUWVJnZ2ZvRGVBR25mekNkNGZUc1djTGJhbDlzRnBxWHNRSThJUWkxNDkzbXclM0Q=" } ]

Bad request. The request was malformed or contains invalid parameters.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret for which the grant was requested is expired.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

List certificates listCertificates

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get a list of certificates.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create certificate createCertificate

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Create a new certificate.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

expirationDate: string(date)

Date on which this secret should expire. If not set, by default, it will be set to notAfter date of this certificate. Once the secret expires, a grant can not be requested for it.

certStore *: string(binary)

The file containing the certificate in PEM format

maxLength: 4096

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

type *: string

Type of certificate supported

Response

json

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get certificate by ID getCertificateById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get the certificate
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCertificates.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

expirationDate *: string(date)

meta *: object

Metadata of a secret

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

details *: object

Details of the certificate

subject *: object

Details about the entity to which the certificate is issued.

signatureAlgorithm *: string

Name of the signature algorithm

version *: string

publicKeyAlgorithm *: string

The standard algorithm name for the public key of this certificate

basicConstraints: object

This identifies if the subject of the certificate is a CA

certificateType *: string

The type of this certificate

validity *: object

Details about validity period of this certificate

issuer *: object

Details about the entity that issued the certificate.

keyUsage: array

A list of values defining the purpose of the public key i.e. the key usage extensions from this certificate

serialNumber *: string

Serial number assigned by the CA to this certificate, in hex format

extendedKeyUsage: array

A list of values providing details about the extended key usage extensions from this certificate.

subjectAlternativeName: array

Collection of subject alternative names from the SubjectAltName x509 extension

certificateFileName *: string

Name of certificate file uploaded

type *: string

Type of certificate supported

Examples

application/json

{ "expirationDate": "2024-01-15", "meta": { "id": "string", "type": "string" }, "name": { "id": "string", "type": "string" }, "details": { "subject": { "commonName": "string", "organizationUnit": "string", "organizationName": "string", "localityName": "string", "state": "string", "countryName": "string" }, "signatureAlgorithm": "string", "version": "string", "publicKeyAlgorithm": "string", "basicConstraints": { "certificateAuthority": true }, "certificateType": "string", "validity": { "notBefore": "string", "notAfter": "string" }, "issuer": { "commonName": "string", "organizationUnit": "string", "organizationName": "string", "localityName": "string", "state": "string", "countryName": "string" }, "keyUsage": [ "Digital Signature" ], "serialNumber": "string" }, "certificateFileName": "string", "type": "PEM" }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Replace certificate updateCertificate

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Replaces a certificates.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCertificates.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

expirationDate: string(date)

Date on which this secret should expire. If not set, by default, it will be set to notAfter date of this certificate. Once the secret expires, a grant can not be requested for it.

certStore *: string(binary)

The file containing the certificate in PEM format

maxLength: 4096

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

type *: string

Type of certificate supported

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update certificate patchCertificate

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a certificates.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCertificates.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

expirationDate: string(date)

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

List truststores listTruststores

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

type

state

Custom Query Parameters

Custom Headers

Get a list of truststores.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

type: string

Filter the elements on the response to be of a specific type from {PEM, JKS, JCEKS, PKCS12}

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create truststore createTruststore

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Create a new truststore.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

Response

json

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get truststore by ID getTruststoreById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get the truststore
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listTruststores.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Replace truststore updateTruststore

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Replaces a truststores.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listTruststores.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update truststore patchTruststore

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a truststores.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listTruststores.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

expirationDate: string(date)

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

List keystores listKeystores

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

type

state

Custom Query Parameters

Custom Headers

Get a list of keystores.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

type: string

Filter the elements on the response to be of a specific type from {PEM, JKS, JCEKS, PKCS12}

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create keystore createKeystore

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Create a new keystore.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

Response

json

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get keystore by ID getKeystoreById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get the keystore
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listKeystores.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Replace keystore updateKeystore

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Replaces a keystores.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listKeystores.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update keystore patchKeystore

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a keystores.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listKeystores.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

expirationDate: string(date)

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

List certificate pinsets listCertificatePinsets

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get a list of certificatePinsets.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create certificate pinset createCertificatePinset

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Create a new certificatePinset.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

expirationDate: string(date)

Date on which this secret should expire. If not set, by default, it will be set to one year from the date on which this secret is created/updated. Once the secret expires, a grant can not be requested for it.

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

certificatePinset *: string(binary)

File containing one or more concatenated CA certificates in PEM format

maxLength: 256000

Response

json

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get certificate pinset by ID getCertificatePinsetById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get the certificatePinset
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCertificatePinsets.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

expirationDate *: string(date)

meta *: object

Metadata of a secret

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

details *: array

certificatePinsetFileName *: string

Name of certifiacte pinset file uploaded

Examples

application/json

{ "expirationDate": "2024-01-15", "meta": { "id": "string", "type": "string" }, "name": { "id": "string", "type": "string" }, "details": [ { "subject": { "commonName": "string", "organizationUnit": "string", "organizationName": "string", "localityName": "string", "state": "string", "countryName": "string" }, "signatureAlgorithm": "string", "version": "string", "publicKeyAlgorithm": "string", "basicConstraints": { "certificateAuthority": true }, "certificateType": "string", "validity": { "notBefore": "string", "notAfter": "string" }, "issuer": { "commonName": "string", "organizationUnit": "string", "organizationName": "string", "localityName": "string", "state": "string", "countryName": "string" }, "keyUsage": [ "Digital Signature" ], "serialNumber": "string" } ], "certificatePinsetFileName": "string" }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Replace certificate pinset updateCertificatePinset

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

allowExpiredCert

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Replaces a certificatePinsets.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCertificatePinsets.$[*].meta.id

Query Parameters

allowExpiredCert: boolean

With 'true' to allow uploading expired certificates

default: False

Request Body

multipart/form-data

expirationDate: string(date)

Date on which this secret should expire. If not set, by default, it will be set to one year from the date on which this secret is created/updated. Once the secret expires, a grant can not be requested for it.

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

certificatePinset *: string(binary)

File containing one or more concatenated CA certificates in PEM format

maxLength: 256000

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update certificate pinset patchCertificatePinset

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a certificatePinsets.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCertificatePinsets.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

expirationDate: string(date)

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

List shared secrets listSharedSecrets

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

type

state

Custom Query Parameters

Custom Headers

Get a list of sharedSecrets.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

type: string

Filter the elements on the response to be of a specific type from {UsernamePassword, SymmetricKey, S3Credential, VDPContext, Blob}

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create shared secret createSharedSecret

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new sharedSecret.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Request Body

json

Response

json

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get shared secret by ID getSharedSecretById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get the sharedSecret
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listSharedSecrets.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Replace shared secret updateSharedSecret

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update already created shared secrets. This operation is not allowed for VDPContext type.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listSharedSecrets.$[*].meta.id

Request Body

json

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update shared secret patchSharedSecret

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a sharedSecrets.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listSharedSecrets.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

expirationDate: string(date)

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

List TLS contexts listTlsContexts

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

type

state

Custom Query Parameters

Custom Headers

Get a list of tlsContexts.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

type: string

Filter the elements on the response to be of a specific type from {FlexGateway, Mule, SecurityFabric}

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create TLS context createTlsContext

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new tlsContext.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Request Body

json

Response

json

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get TLS context by ID getTlsContextById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get the tlsContext
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listTlsContexts.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

Successful operation.

Examples

application/json

{}

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Replace TLS context updateTlsContext

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Replaces a tlsContexts.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listTlsContexts.$[*].meta.id

Request Body

json

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update TLS context patchTlsContext

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a tlsContexts.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listTlsContexts.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

expirationDate: string(date)

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

List CRL distributor configs listCrlDistributorConfigs

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get a list of crlDistributorConfigs.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "string", "type": "string" } ]

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Create CRL distributor config createCrlDistributorConfig

POST

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Create a new crlDistributorConfig.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

Request Body

json

expirationDate: string(date)

Date on which this secret should expire. If not set, by default, it will be set to one year from the date on which this secret is created/updated. Once the secret expires, a grant can not be requested for it.

completeCrlIssuerUrl *: string

URL where complete CRL file should be retrieved

maxLength: 2048

frequency *: integer

How frequently should the distributor site be checked for new crl files(in minutes)

min: 2, max: 1000

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

distributorCertificate *: object

Refers to a secret of type certificate. This certificate is used to check integrity of retrieved CRL files. If not defined the retrieved CRL file will be used without signature verification step being performed.

deltaCrlIssuerUrl: string

maxLength: 2048

caCertificate *: object

Refers to a secret of type certificate. Select the CA certificate associated with the
retrieved CRL file. If selected, the retrieved CRL file may contain revoked and/or held
certificates issued by this CA. The CA subject name is obtained as part of the CRL file
that is retrieved. However, the CRL distributor that issued and signed the CRL file may
not be the issuing CA. If this CA certificate is encountered during chain-of-trust processing
then a CRL file for this CA must have been successfully retrieved, validated and still in affect
(not expired) or the chain-of trust processing fails depending on how the 'Require CRL for all CAs'
flag setting configured as described below.

If the TLS Context secret has the 'Require CRL for all CAs' flag set to false, then the CA certificate should be selected. If not selected then prior to successful retrieval and processing of the CRL file there exists a window of time when a revoked CA certificate could be considered valid in chain-of-trust processing.
Else if its set to true, then its not necessary to select the CA

certificate.

Response

json

Resource created successfully.

id *: string

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

message *: string

Examples

application/json

{ "id": { "id": "string", "type": "string" }, "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Resource creation limit exceeded. There are limits on how many of resources of this type can be created, and if that limit exceeds, this error occurs.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Get CRL distributor config by ID getCrlDistributorConfigById

GET

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Query Parameters

state

Custom Query Parameters

Custom Headers

Get the crlDistributorConfig
with id =
{secretId}

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCrlDistributorConfigs.$[*].meta.id

Query Parameters

state: string

Get the response which is built from the draft state. This is allowed only to the user who currently holds the lock on the containing secret group.

Response

json

Successful operation.

completeCrlIssuerUrl *: string

URL from where complete CRL file is retrieved

frequency *: integer

How frequently should the distributor site be checked for new crl files(in minutes)

min: 2, max: 1000

expirationDate *: string(date)

meta *: object

Metadata of a secret

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

distributorCertificate *: object

Refers to secret of type certificate

deltaCrlIssuerUrl: string

URL from where the changes in CRL file can be retrieved

caCertificate *: object

Refers to secret of type certificate

Examples

application/json

{ "completeCrlIssuerUrl": "string", "frequency": 0, "expirationDate": "2024-01-15", "meta": { "id": "string", "type": "string" }, "name": { "id": "string", "type": "string" }, "distributorCertificate": { "path": "string", "modifiedAt": "string" }, "deltaCrlIssuerUrl": "string", "caCertificate": { "path": "string", "modifiedAt": "string" } }

Not found. The requested resource does not exist.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Replace CRL distributor config updateCrlDistributorConfig

PUT

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Replaces a crlDistributorConfigs.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCrlDistributorConfigs.$[*].meta.id

Request Body

json

expirationDate: string(date)

Date on which this secret should expire. If not set, by default, it will be set to one year from the date on which this secret is created/updated. Once the secret expires, a grant can not be requested for it.

completeCrlIssuerUrl *: string

URL where complete CRL file should be retrieved

maxLength: 2048

frequency *: integer

How frequently should the distributor site be checked for new crl files(in minutes)

min: 2, max: 1000

name *: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

distributorCertificate *: object

Refers to a secret of type certificate. This certificate is used to check integrity of retrieved CRL files. If not defined the retrieved CRL file will be used without signature verification step being performed.

deltaCrlIssuerUrl: string

maxLength: 2048

caCertificate *: object

Refers to a secret of type certificate. Select the CA certificate associated with the
retrieved CRL file. If selected, the retrieved CRL file may contain revoked and/or held
certificates issued by this CA. The CA subject name is obtained as part of the CRL file
that is retrieved. However, the CRL distributor that issued and signed the CRL file may
not be the issuing CA. If this CA certificate is encountered during chain-of-trust processing
then a CRL file for this CA must have been successfully retrieved, validated and still in affect
(not expired) or the chain-of trust processing fails depending on how the 'Require CRL for all CAs'
flag setting configured as described below.

If the TLS Context secret has the 'Require CRL for all CAs' flag set to false, then the CA certificate should be selected. If not selected then prior to successful retrieval and processing of the CRL file there exists a window of time when a revoked CA certificate could be considered valid in chain-of-trust processing.
Else if its set to true, then its not necessary to select the CA

certificate.

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group this operation is being performed on, is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Update CRL distributor config patchCrlDistributorConfig

PATCH

Try it out

Path Parameters

organizationId *

environmentId *

secretGroupId *

secretId *

Custom Query Parameters

Custom Headers

Request Body application/json

Updates a crlDistributorConfigs.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

secretGroupId *: string

The secret group id, generated during creation of this secret group

maxLength: 50

Related Operations:

secrets-manager#listSecretGroups.$[*].meta.id

secretId *: string

The secret ID to identify the target resource.

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Related Operations:

secrets-manager#listCrlDistributorConfigs.$[*].meta.id

Request Body

json

name: string

minLength: 3, maxLength: 35, pattern: ^[a-zA-Z][-a-zA-Z0-9]*$

expirationDate: string(date)

Response

json

Successful operation.

message *: string

Examples

application/json

{ "message": "string" }

Bad Request.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

state of conflict. This can occur if the secret group is not yet locked, or is locked by another user.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Internal server error.

message *: string

Human readable error description.

errors: array

Error list used to describe the set of conflicts and failed validations. Required when
HTTP error code is not enough for describing the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "PT-1001", "message": "string", "field": "string" } ] }

Parse certificate file details parseCertificateDetails

POST

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Creates a certificates.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Request Body

multipart/form-data

file *: string(binary)

file to parse

maxLength: 256000

Response

json

Successful operation.

certificates: array

Examples

application/json

{ "certificates": [ { "issuer": { "commonName": "Acme Root" }, "subject": { "commonName": "Acme Root" }, "version": "3", "serialNumber": "2963503AF1E9B1DB00E2BE0B7BDAB4160FFA2C28", "subjectAlternativeName": [ "2", "internal.acme.com" ], "signatureAlgorithm": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "basicConstraints": { "certificateAuthority": true }, "keyUsage": [ "Key CertSign", "CRL Sign" ], "certificateType": "X.509", "validity": { "notBefore": "2016-07-04T21:00:00", "notAfter": "2018-07-04T21:00:00" } }, { "issuer": { "commonName": "Acme Root" }, "subject": { "commonName": "Acme" }, "version": "3", "serialNumber": "9ABD5B470FE43B23575DC8F54AD4550FE26CB7C", "signatureAlgorithm": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "basicConstraints": { "certificateAuthority": true }, "keyUsage": [ "Key CertSign", "CRL Sign" ], "certificateType": "X.509", "validity": { "notBefore": "2016-07-04T21:00:00", "notAfter": "2018-07-04T21:00:00" } } ] }

Parse keystore or truststore details parseStoreDetails

POST

Try it out

Path Parameters

organizationId *

environmentId *

Custom Query Parameters

Custom Headers

Request Body multipart/form-data

Creates a store.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

environmentId *: string

The environment ID to identify the target resource.

Related Operations:

access-management#listEnvironments.$.data[*].id

Request Body

multipart/form-data

file *: string(binary)

file to parse

maxLength: 40960

storePassphrase *: string

maxLength: 64

type *: string

Response

json

Successful operation.

entries: array

Examples

application/json

{ "entries": [ { "alias": "capath", "entryType": "Cert", "certificates": [ { "issuer": { "commonName": "Acme Root" }, "subject": { "commonName": "Acme Root" }, "version": "3", "serialNumber": "36469B2157E3942CB194285C60975C7F228ED2EA", "subjectAlternativeName": [ "2", "infrastructure.acme.com" ], "signatureAlgorithm": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "basicConstraints": { "certificateAuthority": true }, "keyUsage": [ "Key CertSign", "CRL Sign" ], "certificateType": "X.509", "validity": { "notBefore": "2016-07-04T21:00:00", "notAfter": "2018-07-04T21:00:00" } } ] } ] }

Overview

Servers

Authentication & Security

Delete organization deleteOrganization

Try it out

Response

Path Parameters

Response

Delete environment deleteEnvironment

Try it out

Response

Path Parameters

Response

List operation statuses listOperations

Try it out

Response

Path Parameters

Query Parameters

Response

List secret groups listSecretGroups

Try it out

Response

Path Parameters

Query Parameters

Response

Create secret group createSecretGroup

Try it out

Response

Path Parameters

Request Body

Response

Get secret group by ID getSecretGroupById

Try it out

Response

Path Parameters

Response

Update secret group patchSecretGroup

Try it out

Response

Path Parameters

Request Body

Response

Delete secret group deleteSecretGroup

Try it out

Response

Path Parameters

Query Parameters

Response

Acquire secret group lock (deprecated) acquireSecretGroupLock

Try it out

Response

Path Parameters

Response

Release secret group lock (deprecated) releaseSecretGroupLock

Try it out

Response

Path Parameters

Query Parameters

Response

Clone secret group cloneSecretGroup

Try it out

Response

Path Parameters

Request Body

Response

Cancel secret group clone cancelSecretGroupClone

Try it out

Response

Path Parameters

Response

Create secret access grants createSecretGrants

Try it out

Response

Path Parameters

Request Body

Response

List certificates listCertificates

Try it out

Response