List Applications
List applications the currently logged in developer can access.
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 the id of the auth strategy supported by the application.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by the id of the auth strategy supported by the application (short-hand).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by the team that owns the application. Use a team UUID or the literal string null for individually owned apps (e.g. filter[team_id][eq]=null).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by the team that owns the application (short-hand). Use a team UUID or the literal string null for individually owned apps (e.g. filter[team_id]=null).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by excluding a team. Use the literal string null to get only team-owned apps (excludes individually owned) (e.g. filter[team_id][neq]=null).
Example:null
Filter by apps owned by any of the given teams (comma-separated UUIDs).
Example:5be86298-147b-45ab-bfaf-a1bff97dce39,7ce96398-247b-45ab-bfaf-b2c008e8f6e4
Response
application/json
Response
Get applications response
ListApplicationsResponse
returns the pagination information
Show Child Parameters
Show Child Parameters
Create Application
Creates a new Application.
Body
application/json
Body
Create an application
CreateApplicationPayload
Application creation payload
The name of the application
<= 255 characters
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 255 characters
URL to redirect to after completing an OIDC auth flow
A brief description of the application
<= 255 characters
ID of the auth strategy to use for the application. If null or not included, the default application auth strategy will be used.
The granted scopes for the application. Will only be included if supported by the application’s auth strategy.
ID of the team to assign the application to.
Response
application/json
Response
Application Creation success
ApplicationCreationResponse
Application creation response payload
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 255 characters
The client secret used to authenticate with registered APIs.
<= 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
ID of the team to assign the application to.
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
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 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
ID of the team to assign the application to.
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
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 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.
ID of the team to assign the application to.
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
A unique value used to identify the portal application when authenticating with a Client Secret.
<= 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
ID of the team to assign the application to.