0.0.0OAS 3.0

Konnect Organizations API.

API Base URL
  • Server 1:https://us.api.konghq.com/v0

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v0

    Europe Production region

  • Server 3:https://au.api.konghq.com/v0

    Australia Production region

  • Server 4:https://me.api.konghq.com/v0

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v0

    India Production region

  • Server 6:https://sg.api.konghq.com/v0

    Singapore Production region

Security
serviceAccessToken (http)

The Service access token is meant to be used between internal services.

Additional Information
Contact Kong

Organizations

API related to the management of Konnect Organizations

Get entitlements

Returns the entitlements for a given organization. Internal endpoint for kadmin.

get

Path Parameters

organizationIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

application/json

Entitlements for this organization.

GetEntitlementsResponse

* Additional properties are NOT allowed.
portals_limitnumberrequired

Example:4

get/organizations/{organizationId}/entitlements
 
application/json

Update entitlements

Update the entitlements for a given organization. Internal endpoint for kadmin.

patch

Path Parameters

organizationIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

Update an organization’s entitlements.

Entitlements

* Additional properties are NOT allowed.
portals_limitnumberrequired

Example:4

Response

application/json

Entitlements for this organization.

GetEntitlementsResponse

* Additional properties are NOT allowed.
portals_limitnumberrequired

Example:4

patch/organizations/{organizationId}/entitlements

Body

{ "portals_limit": 3 }
 
application/json

Entitlements

object
* Additional properties are NOT allowed.
portals_limitnumberrequired

Example:4

Example