Sign in
Auth Settings

Patch Mappings by Team ID

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

Changed in 3 of the 75 revisions of this API.1113

  • 845120e19d453See the full diff
    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property // became not nullable

      request-property-became-not-nullable

    • ▲

      the request property // became not nullable

      request-property-became-not-nullable

  • 8ab3ec3ed3011See the full diff
    • ●

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

      response-property-enum-value-added

  • 3c0154b2053a83See the full diff
    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property /////// became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ▲

      the response property // became nullable for the status

      response-property-became-nullable

    • ○

      the request property became nullable

      request-property-became-nullable

    • ○

      the request property // became nullable

      request-property-became-nullable

    • ○

      the request property // became nullable

      request-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog