Portal Auth Settings

List Team Group Mappings

Changed on

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Lists mappings between Konnect portal teams and Identity Provider (IdP) groups. Returns a 400 error if an IdP has not yet been configured.

get/v3/portals/{portalId}/identity-provider/team-group-mappings

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/identity-provider/team-group-mappings
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

page[size]integer
Example:10

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

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Response

A paginated collection of mappings grouped by team ID.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 2
    }
  },
  "data": [
    {
      "team_id": "6801e673-cc10-498a-94cd-4271de07a0d3",
      "groups": [
        "Tech Leads",
        "API Engineers"
      ]
    },
    {
      "team_id": "7301e673-cc10-498a-94cd-4271de07a0d3",
      "groups": [
        "Managers",
        "Directors"
      ]
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status