List Credentials by Application

Lists all credentials for an application. This endpoint returns both API key credentials and DCR credentials, depending on the auth strategy the application uses: - For DCR applications: Credential information is retrieved from the identity provider using provider-specific APIs - For Key-Auth applications: Returns information about credentials Basic information about the credential is returned, but not the credential secret itself.

get

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

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)required

ID of the application.

Response

application/json

A paginated list of credentials for an application.

ListCredentialsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
array[object]required
ApiKeyCredentialListItemobject

API key credential returned when listing credentials.

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/applications/{applicationId}/credentials
 
application/json

Application Registrations

APIs related to Konnect Developer Portal Application Registrations.

List Registrations by Portal

Lists all of the application registrations and their current status (e.g., approved or pending) for this portal. Each registration is associated with a single API. Access is provided through the credentials issued to the application that contains each registration.

get

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

sortstring

Sorts a collection of application registrations. Supported sort attributes are:

  • created_at
  • updated_at
  • developer_id
  • status
filterobject

Filter application registrations returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of application registrations.

ListApplicationRegistrationsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

A application’s registration for a specific version of an API.

Example:{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/application-registrations
 
application/json

List Registrations by Application

Lists each API that this application is registered for and their current status (e.g., pending, approved, rejected, revoked).

get

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

sortstring

Sorts a set of registrations for an application. Supported sort attributes are:

  • created_at
  • updated_at
  • status
filterobject

Filter application registrations returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)required

ID of the application.

Response

application/json

A paginated list of application registrations.

ListApplicationRegistrationsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

A application’s registration for a specific version of an API.

Example:{"id":"c300cc33-2d33-4754-b086-a98e0fcd36fb","status":"approved","application":{"id":"c15e2460-ba40-431d-9df0-4957fcff7cda","name":"App 1"},"api":{"id":"86f637b7-cd95-478b-9b02-d770618f641c","name":"Great Stuff","version":"v1","entity_type":"api"},"created_at":"2022-12-22T20:13:07.305Z","updated_at":"2022-12-22T20:13:36.710Z"}

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/applications/{applicationId}/registrations
 
application/json

Get a Registration

Returns information about an application’s registration status for a particular API.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)required

ID of the application.

registrationIdstring(uuid)required

ID of the application registration.

Response

application/json

Details about an application registration.

GetApplicationRegistrationResponse

A application’s registration for a specific version of an API.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

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

statusstringrequired

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved.
Pending, revoked, and rejected registrations will not provide access to the API.

Allowed values:approvedpendingrevokedrejected

Example:approved

apiobjectrequired

Details about the API the application is registered to.

* Additional properties are NOT allowed.
Show Child Parameters
applicationobjectrequired

Details about the application the registration is part of.

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/applications/{applicationId}/registrations/{registrationId}
 
application/json