Create Application

Creates a new Application.

post
/api/v3/applications

Body

application/json

Create an application

CreateApplicationPayload

Application creation payload

* Additional properties are NOT allowed.
namestringrequired

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

auth_strategy_idstring | null(uuid)

ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.

scopesarray[string]

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

team_idstring | null(uuid)

ID of the team to assign the application to.

Response

application/json

Application Creation success

ApplicationCreationResponse

Application creation 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
descriptionstring | nullrequired
redirect_uristring | null
client_idstring

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

<= 255 characters

client_secretstring

The client secret used to authenticate with registered APIs.

<= 255 characters

auth_strategyOne Of
objectrequired
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 | null(uuid)

ID of the team to assign the application to.

application/json

Get an Application

Gets the details for an existing application. You need only supply the unique application identifier that was returned upon application creation or by the list-applications endpoint.

get
/api/v3/applications/{applicationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

application/json

Get application response

GetApplicationResponse

* 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

descriptionstring | nullrequired
redirect_uristring | null
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 | null(uuid)

ID of the team to assign the application to.

application/json

Delete Application

Deletes an application and all of its associated entities (registrations).

delete
/api/v3/applications/{applicationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

Application was deleted successfully.

Update Application

Updates an application, replacing specified properties with any new values supplied in the request body.

patch
/api/v3/applications/{applicationId}

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Body

application/json

Update an application

UpdateApplicationPayload

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 | null(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 | null(uuid)

ID of the team to assign the application to.

Response

application/json

Application Update success

ApplicationUpdateResponse

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

descriptionstring | nullrequired

Example:A brief description of the application

redirect_uristring | null

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 | null(uuid)

ID of the team to assign the application to.

application/json

Get granted scopes

Retrieves the granted scopes of a specified application and API directly from the IDP.
Scopes shared between APIs will be returned, even if not currently registered for given API.
Will return 422 if this feature is not supported by the application.

get
/api/v3/applications/{applicationId}/granted-scopes

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

application/json

Get granted scopes response.

GetGrantedScopesAPIResponse

* Additional properties are NOT allowed.
scopesarray[string]required

List of granted scopes, directly updated from the IDP

application/json