Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|

Konnect Identity API

v2.0.0OAS 3.0

The management API for Kong Konnect Identity resources.

API Base URL
  • Server 1:https://global.api.konghq.com/v2

    Global Base URL

Security
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...'

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...'

konnectAccessToken (http)

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

Additional Information
Contact Kong

Get Auth Settings

Returns authentication configuration, which determines how users can log in and how they are assigned to teams.

get
https://global.api.konghq.com/v2/authentication-settings

Response

application/json

Response for authentication settings endpoint

basic_auth_enabledboolean

The organization has basic auth enabled.

Example:true

oidc_auth_enabledboolean

The organization has OIDC disabled.

Example:false

idp_mapping_enabledboolean

IdP groups determine the Konnect teams a user has.

Example:true

konnect_mapping_enabledboolean

A Konnect Identity Admin assigns teams to a user.

Example:false

get/authentication-settings
 
application/json