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.
Path Parameters
Id of the targeted application
Response
application/json
Response
Get application response
GetApplicationResponse
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
One OfKeyAuth Auth strategy that the application uses.
Show Child Parameters
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Delete Application
Deletes an application and all of its associated entities (registrations).
Path Parameters
Id of the targeted application
Response
Response
Application was deleted successfully.
Update Application
Updates an application, replacing specified properties with any new values supplied in the request body.
Path Parameters
Id of the targeted application
Body
application/json
Body
Update an application
UpdateApplicationPayload
Payload required to update an application
The name of the application
<= 255 characters
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
URL to redirect to after completing an OIDC auth flow
A brief description of the application
<= 255 characters
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
Response
application/json
Response
Application Update success
ApplicationUpdateResponse
Application update response payload
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An identifier to correlate the application with an external system.
Cannot be set when using Dynamic Client Registration.
<= 255 characters
Example:A brief description of the application
Example:https://example.com/callback
One OfKeyAuth Auth strategy that the application uses.
Show Child Parameters
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Get the granted scopes
Retrieves the granted scopes of a specified application and product version directly from the IDP.
Scopes shared between product versions will be returned, even if not currently registered for given product version.
Will return 422 if this feature is not supported by the application.
Path Parameters
Id of the targeted application
Contains a unique identifier used by the Portal API for this resource.
Response
application/json
Response
Get granted scopes response.
GetGrantedScopesProductVersionResponse
List of granted scopes, directly updated from the IDP
List the available auth strategies
Retrieve the available Auth Strategies on this portal.
An Auth Strategy is a set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version.
It may reference to Key-Auth or an OIDC configuration (with or without DCR).
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter by direct equality comparison of the name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the name property with a supplied value.
Example:good service
Filter by contains comparison of the name property with a supplied substring
Example:good service
Filter by direct equality comparison of the credential_type with a supplied value.
Allowed values:client_credentialsself_managed_client_credentialskey_auth
Example:key_auth
Response
application/json
Response
List auth strategies response
ListAuthStrategiesResponse
returns the pagination information
Show Child Parameters
One OfKeyAuth Auth strategy that the application uses.