Create internal credentials

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

Creates credentials for accounts/sub-accounts. This endpoint is idempotent. Same externalId + type with same data = success (returns existing credential). Conflicting externalId + type with different data = 409 Conflict.

Request Body

credentialGroups array[object] required
Request body for creating a single credential
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
enterpriseId string required
Min length: >= 1 characters
encryptedCredentials string required
Min length: >= 1 characters
expiresAt string <date-time>

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

409 Response

errorName string required
error string required

422 Response

errorName string required
error string required

500 Response

errorName string required
error string required