Ctrl+K

Update internal credentials

put/credential-management-service/api/cms/v1/internal/credentials

Updates credentials for internal BitGo services. Supports:

  • Credential rotation (with credentialUpdate)
  • Deactivation/reactivation (with active flag)
  • Combo updates (both rotation AND active flag change)

Request Body

credentials array[object] required
Single credential update item - id: Required - credential to update - expiresAt: Optional - update expiration date - credentialUpdate: Optional - present = rotation flow with new encrypted credentials - active: Optional - deactivation/reactivation flag
id string required
expiresAt string <date-time>
credentialUpdate object
Credential update payload for rotating credentials Contains all envelope encryption fields
active boolean

200 Response

credentials array[object] required
id string required
externalId string required
Min length: >= 1 characters
type string required
Allowed values: READ WRITE READ_WRITE
wrappedKey string required
Min length: >= 1 characters
iv string required
Min length: >= 1 characters
tag string required
Min length: >= 1 characters
masterKeyVersion number required
venueIdentifier string required
Min length: >= 1 characters
active boolean required
enterpriseId string required
Min length: >= 1 characters
encryptedCredentials string required
Encrypted credentials as a single base64-encoded blob.
Min length: >= 1 characters
createdAt string <date-time>required
updatedAt string <date-time>required
expiresAt string <date-time>

400 Response

errorName string required
error string required

401 Response

errorName string required
error string required

404 Response

errorName string required
error string required

422 Response

errorName string required
error string required

500 Response

errorName string required
error string required