API docs by Redocly

Portal Registrations (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

N/A (this description is removed during bundling)

registrations

The API for Konnect Portal application registrations. If the portal is public all of the described endpoints will return a 404 error

Get application registrations

Lists product registrations for an application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

query Parameters
page[size]
integer
Example: page[size]=10

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

page[number]
integer
Example: page[number]=1

Determines which page of the entities to retrieve.

filter[id][eq]
string
Example: filter[id][eq]=5be86298-147b-45ab-bfaf-a1bff97dce39

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

filter[id]
string
Example: filter[id]=5be86298-147b-45ab-bfaf-a1bff97dce39

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

filter[status][eq]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status][eq]=approved

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

filter[status]
string
Enum: "approved" "pending" "rejected" "revoked"
Example: filter[status]=approved

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

filter[product_name][eq]
string
Example: filter[product_name][eq]=good service

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

filter[product_name]
string
Example: filter[product_name]=good service

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

filter[product_version_name][eq]
string
Example: filter[product_version_name][eq]=good service

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

filter[product_version_name]
string
Example: filter[product_version_name]=good service

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

filter[product_version_name][contains]
string
Example: filter[product_version_name][contains]=good service

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

filter[product_name][contains]
string
Example: filter[product_name][contains]=good service

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

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Register an application for a product

Registers an application for a product.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

Request Body schema: application/json

Create an application registration.

product_version_id
required
string <uuid>

The product version id required for registration.

scopes
Array of strings

The requested scopes for the registration, requires developer_managed_scopes to be enabled.

Responses

Request samples

Content type
application/json
{
  • "product_version_id": "8bb4c6a0-a679-47fe-8af0-8454849ab62d",
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "status": "approved",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "product_name": "string",
  • "product_version_id": "8bb4c6a0-a679-47fe-8af0-8454849ab62d",
  • "product_version_name": "string",
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  • "granted_scopes": [
    ]
}

Get an application registration

Retrieves the specified product registration for an application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  • "created_at": "2022-11-04T20:10:06.927Z",
  • "updated_at": "2022-11-04T20:10:06.927Z",
  • "status": "approved",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "product_name": "string",
  • "product_version_id": "8bb4c6a0-a679-47fe-8af0-8454849ab62d",
  • "product_version_name": "string",
  • "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  • "granted_scopes": [
    ]
}

Delete an application registration

Unregister an application for a product version.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Get the granted scopes of an application registration

Retrieves the granted scopes of a specified product registration directly from the IDP for an application. Will return 409 if this feature is not supported by the application.

Authorizations:
portalAccessToken
path Parameters
applicationId
required
string <uuid>

Id of the targeted application

registrationId
required
string <uuid>

Contains a unique identifier used by the Portal API for this resource.

Responses

Response samples

Content type
application/json
{
  • "scopes": [
    ]
}