Sign in
Teams

Update Team

Updates an individual team.

patch/v3/teams/{teamId}

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

Changed in 7 of the 75 revisions of this API.1296

  • fbe6ce110ba4371See the full diff
    • ▲

      the description request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      removed the optional property created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property description from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property labels from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property system_team from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property updated_at from the response with the 200 status

      response-optional-property-removed

    • ○

      added Team subschema #2 to the response body allOf list for the response status 200

      response-body-all-of-added

  • 4fef3868064f1See the full diff
    • ●

      the name request property's maxLength was set to 250

      request-property-max-length-set

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

  • 845120e19d452See the full diff
    • ▲

      the request property description became not nullable

      request-property-became-not-nullable

    • ▲

      the request property name became not nullable

      request-property-became-not-nullable

  • 8ab3ec3ed3011See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • 3c0154b2053a73See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property description became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property name became nullable for the status 200

      response-property-became-nullable

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      the request property name became nullable

      request-property-became-nullable

    • ○

      the system_team response's property default value false was added for the status 200

      response-property-default-value-added

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

  • 6333a0d3b0951See the full diff
    • ○

      the system_team response's property default value false was removed for the status 200

      response-property-default-value-removed

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

  • 76b0fefddb0d1See the full diff
    • ○

      the system_team response's property default value false was added for the status 200

      response-property-default-value-added