UpdateApplicationPayload

object

Payload required to update an application

* Additional properties are NOT allowed.
namestring

The name of the application

<= 255 characters

client_idstring

A unique value used to identify the portal application when authenticating with a Client Secret.

<= 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.

team_idstring(uuid)

ID of the team to assign the application to.

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
client_idstring

A unique value used to identify the portal application when authenticating with a Client Secret.

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

team_idstring(uuid)

ID of the team to assign the application to.

Example

Regenerate secret response

object

Regenerate secret response

* Additional properties are NOT allowed.
client_idstringrequired
client_secretstringrequired
Example

PageMeta

object

Contains pagination query parameters and the total number of objects returned.

numbernumberrequired

Example:1

sizenumberrequired

Example:10

totalnumberrequired

Example:100

Example

PaginatedMeta

object

returns the pagination information

pageobjectrequired

Contains pagination query parameters and the total number of objects returned.

Show Child Parameters
Example