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

Update Registration

Updates the status of a particular application registration to an API. Approved application registrations will allow API traffic to the corresponding API. Revoked, rejected, or pending will not allow API traffic.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

applicationIdstring(uuid)required

ID of the application.

registrationIdstring(uuid)required

ID of the application registration.

Body

application/json

Update an application registration.

UpdateApplicationRegistrationRequest

* Additional properties are NOT allowed.
statusstring

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

Response

application/json

Details about the application registration being updated.

UpdateApplicationRegistrationResponse

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
patch/portals/{portalId}/applications/{applicationId}/registrations/{registrationId}

Body

{ "status": "rejected" }
 
application/json

Delete Registration

Deletes an application registration, which if currently approved will immediately block API traffic to the API.
Note: Developers can request a new application registration for the given API as long as they have RBAC access to consume.

delete

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

No Content

delete/portals/{portalId}/applications/{applicationId}/registrations/{registrationId}
 

Portal Emails

APIs related to Konnect Developer Portal Emails.

List email domains

List email domains

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 email domains. Supported sort attributes are:

  • domain
  • created_at
  • updated_at
filterobject

Filter email domains returned in the response.

Show Child Parameters

Response

application/json

List of a email domains

ListDomains

dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/portals/email-domains
 
application/json