Skip to main content

CredentialResponse

Credential metadata — secret values are always masked

idstring
Example: 01HX9QRPBZW4EZG3BTYV7K0M5C
namestring
Example: acme-sftp-key
credentialTypeCredentialType (string)

Type of credential secret

Possible values: [SSH_KEY, PASSWORD, API_TOKEN, AWS_ACCESS_KEY, AZURE_SAS, GCP_SERVICE_ACCOUNT, OAUTH2_CLIENT]

Example: SSH_KEY
usernamestringnullable
Example: sftp-user
maskedValuestring

Last 4 chars of secret, rest masked — e.g. "****KEY"

Example: ****KEY
createdAtstring<date-time>
Example: 2024-03-15T08:00:00Z
updatedAtstring<date-time>
Example: 2024-03-15T09:30:00Z
rotatedAtstring<date-time>nullable
Example: null
CredentialResponse
{
"id": "01HX9QRPBZW4EZG3BTYV7K0M5C",
"name": "acme-sftp-key",
"credentialType": "SSH_KEY",
"username": "sftp-user",
"maskedValue": "****KEY",
"createdAt": "2024-03-15T08:00:00Z",
"updatedAt": "2024-03-15T09:30:00Z",
"rotatedAt": null
}