2.0.5OAS 3.0

Internal API for managing entitlements for an organization.

API Base URL
  • Server 1:http://entitlements-api.entitlements.svc.cluster.local:8080/v2

    Entitlements API server

Security
konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

Additional Information
Contact Kong

Entitlements

Manage entitlements for an organization

Get organization entitlements

Get all entitlements for an organization

get
http://entitlements-api.entitlements.svc.cluster.local:8080/v2/internal/entitlements

Response

application/json

A list of all entitlements for the organization

OrgEntitlements

billing_and_meteringobjectrequired
Show Child Parameters
kong_identityobjectrequired
Show Child Parameters
developer_portalobjectrequired
Show Child Parameters
catalogobjectrequired
Show Child Parameters
event_gatewayobjectrequired
Show Child Parameters
advanced_analyticsobjectrequired
Show Child Parameters
ai_gatewayobjectrequired
Show Child Parameters
dedicated_cloud_gatewayobjectrequired
Show Child Parameters
meshobjectrequired
Show Child Parameters
self_managed_gatewayobjectrequired
Show Child Parameters
serverless_gatewayobjectrequired
Show Child Parameters
kic_gatewayobjectrequired
Show Child Parameters
payload_captureobjectrequired
Show Child Parameters
get/internal/entitlements
 
application/json