3.0.2OAS 3.0

The management API for Kong Konnect Identity resources.

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

    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.

clientToken (http)

The Client token is meant to be used by internal service clients for the MinK integration.

serviceAccessToken (http)

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

Additional Information
Contact Kong

Auth Settings

List Team Group Mappings

Returns a paginated list of team group mappings for the specified identity provider.
Mappings define the relationship between identity provider groups and Konnect teams.

get
https://global.api.konghq.com/v3/identity-providers/{idpId}/team-group-mappings

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[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter mappings by team ID or group name.

Show Child Parameters

Path Parameters

idpIdstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

A paginated collection of IDP team group mappings.

metaobject

Pagination metadata.

Show Child Parameters
dataarray[object]

A mapping between a Konnect team and an identity provider group.

Show Child Parameters
get/identity-providers/{idpId}/team-group-mappings
 
application/json

Create Team Group Mapping

Creates a new team group mapping for the specified identity provider.
A mapping associates an identity provider group with a Konnect team.

post
https://global.api.konghq.com/v3/identity-providers/{idpId}/team-group-mappings

Path Parameters

idpIdstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Request to create an IDP team group mapping.

team_idstring(uuid)required

The Konnect team ID to associate with the identity provider group.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The identity provider group name. Group names are case sensitive.

Example:Tech Leads

Response

application/json

A single team group mapping.

IdpTeamGroupMapping

A mapping between a Konnect team and an identity provider group.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The identity provider group name. Group names are case sensitive.

Example:Tech Leads

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

post/identity-providers/{idpId}/team-group-mappings

Body

{ "team_id": "6801e673-cc10-498a-94cd-4271de07a0d3", "group": "Tech Leads" }
 
application/json

Get Team Group Mapping

Returns the team group mapping for the specified ID.

get
https://global.api.konghq.com/v3/identity-providers/{idpId}/team-group-mappings/{id}

Path Parameters

idpIdstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

idstring(uuid)required

ID of the team group mapping.

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

Response

application/json

A single team group mapping.

IdpTeamGroupMapping

A mapping between a Konnect team and an identity provider group.

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The identity provider group name. Group names are case sensitive.

Example:Tech Leads

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

get/identity-providers/{idpId}/team-group-mappings/{id}
 
application/json