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

List Available Auth Strategies

Retrieve the auth strategies on this portal.
An auth strategy represents the way your application provides credentials to authenticate with an API.

get
/api/v3/application-auth-strategies

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filter[name][eq]string

Filter by direct equality comparison of the name property with a supplied value.

Example:good service

filter[name]string

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

Example:good service

filter[name][contains]string

Filter by contains comparison of the name property with a supplied substring

Example:good service

filter[credential_type][eq]string

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

List auth strategies response

ListAuthStrategiesResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
array[object]required
PortalAuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

Show Child Parameters
application/json

Credentials

The API for Konnect Portal developer credentials within a private portal (i.e. requires registration/authentication).