UpdateApplicationPayload

object

Payload required to update an application

* Additional properties are NOT allowed.
namestring

The name of the application

<= 255 characters

reference_idstring

An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.

<= 255 characters

redirect_uristring(uri)

URL to redirect to after completing an OIDC auth flow

descriptionstring

A brief description of the application

<= 255 characters

scopesarray[string]

The granted scopes for the application. Will only be included if supported by the application’s auth strategy.

Example

ApplicationUpdateResponse

object

Application update response payload

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

Contains a unique identifier used for this resource.

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

namestringrequired
reference_idstringrequired

An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.

<= 255 characters

descriptionstringrequired

Example:A brief description of the application

redirect_uristring

Example:https://example.com/callback

auth_strategyOne Of
object
PortalAuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

Show Child Parameters
scopesarray[string]

The granted scopes for the application. Will only be included if supported by the application’s auth strategy.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

Example

Refresh token response

object

Refresh token response

* Additional properties are NOT allowed.
client_idstringrequired
client_secretstringrequired
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