AuthStrategyKeyAuth

object

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The Application Auth Strategy ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

Default:name

Example:name

credential_typestringrequired

Allowed values:key_auth

key_namesarray[string]required
ttlobject

Default maximum Time-To-Live for keys created under this strategy.

Show Child Parameters
Example

ApiKeyCredentialListItem

object

API key credential returned when listing credentials.

* 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
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

ClientSecretCredentialListItem

object

Client secret credential returned when listing credentials.

* Additional properties are NOT allowed.
typestringrequiredread-only

Allowed values:client_secret

idstringrequired

Credential identifier

display_namestring

May not be available for all Client Credentials applications

client_idstringrequiredread-only

OAuth2 client identifier

created_atstring(date-time)requiredread-only

Creation timestamp, if available

expires_atstring(date-time)read-only

Expiration timestamp, if applicable

Example

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