Teams

Update Team

Changed on

Updates an individual team.

patch/v3/teams/{teamId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/teams/{teamId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring

The name of the team.

descriptionstring

The description of the team.

labelsLabelsUpdate nullable

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Example request

{
  "name": "IDM - Developers",
  "description": "The Identity Management (IDM) API team.",
  "labels": {
    "env": "test"
  }
}

Response

A response including a single team.

idstring uuid required

The team ID.

namestring required

The name of the team.

descriptionstring nullable required

The description of the team.

system_teamboolean required

Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like "Organization Admin", or "Service"

labelsLabels required

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

created_atstring date-time required

A Unix timestamp representation of team creation.

updated_atstring date-time required

A Unix timestamp representation of the most recent change to the team object in Konnect.

Example response

{
  "id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "name": "IDM - Developers",
  "description": "The developers for the IDM API.",
  "system_team": false,
  "labels": {
    "env": "test"
  },
  "created_at": "1992-02-07T17:46:57.52Z",
  "updated_at": "2022-08-31T17:00:00.52Z"
}

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 404.00 enum value to the response property for the response status