CredentialListItem

object
One Of
typestringrequiredread-only

Allowed values:api_key

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

display_namestringrequired
statusstringread-only

Allowed values:activeexpiredrevoked

expires_atstring(date-time)read-only
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

Example

ListCredentialsResponse

object
* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
array[object]required
ApiKeyCredentialListItemobject

API key credential returned when listing credentials.

* Additional properties are NOT allowed.
Show Child Parameters
Example

CreateCredentialRequest

object
* Additional properties are NOT allowed.
display_namestring

<= 255 characters

Example

ApiKeyCredentialCreationResponse

object

Response when creating an API key credential.

* Additional properties are NOT allowed.
typestringrequiredread-only

Allowed values:api_key

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

display_namestringrequired
credentialstringrequired

The API key value (only returned on creation)

statusstringread-only

Allowed values:activeexpiredrevoked

expires_atstring(date-time)read-only
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

Example

ClientSecretCredentialCreationResponse

object

Response when creating a client secret credential.

* Additional properties are NOT allowed.
typestringrequiredread-only

Allowed values:client_secret

idstringrequired

Credential identifier

display_namestring
client_idstringrequiredread-only
client_secretstringrequired

Client secret value (only returned on creation)

created_atstring(date-time)requiredread-only
expires_atstring(date-time)read-only

Expiration timestamp, if applicable

Example