Auth Settings

Patch Mappings by Team ID

Changed on

Allows partial updates to the mappings between Konnect Teams and Identity Provider Groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list.

Returns a 400 error if an Identity Provider has not yet been configured, or if a team ID in the request body is not found or is not a UUID.

patch/v3/identity-provider/team-group-mappings

Request

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

Request body

Example request

{
  "data": [
    {
      "team_id": "af91db4c-6e51-403e-a2bf-33d27ae50c0a",
      "groups": [
        "Service Developers"
      ]
    }
  ]
}

Response

A paginated collection of mappings grouped by team_id.

Example response

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

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