Teams

List Teams

Returns an array of team objects containing information about the Konnect Teams.

get
https://global.api.konghq.com/v3/teams

Query Parameters

page[size]integer

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

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filter teams returned in the response.

Show Child Parameters

Response

application/json

A paginated list response for a collection of users.

Team Collection Response

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

The team object contains information about a group of users.

Example:{"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"}

Show Child Parameters
get/teams
 
application/json

Create Team

Creates a team in the Konnect Organization.

post
https://global.api.konghq.com/v3/teams

Body

application/json

The request schema for the create team request.

If you pass the same name and description of an existing team in the request, a team with the same name and description will be created. The two teams will have different team_id values to differentiate them.

namestringrequired

A name for the team being created.

Match pattern:^[\w \W]+$

Example:IDM - Developers

descriptionstring

The description of the new team.

<= 250 characters

Example:The Identity Management (IDM) team.

labelsobject

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 “_”.

Example:{"env":"test"}

Response

application/json

A response including a single team.

Team

The team object contains information about a group of users.

idstring(uuid)read-only

The team ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The name of the team.

Match pattern:^[\w \W]+$

<= 250 characters

Example:IDM - Developers

descriptionstring

The team description in Konnect.

<= 250 characters

Example:The developers for the IDM API.

system_teambooleanread-only

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

Default:false

labelsobject

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 “_”.

Example:{"env":"test"}

created_atstring(date-time)read-only

A Unix timestamp representation of team creation.

Example:1992-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

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

Example:2022-02-07T17:00:00.52Z

post/teams

Body

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

Get a Team

Returns information about a team from a given team ID.

get
https://global.api.konghq.com/v3/teams/{teamId}

Path Parameters

teamIdstring(uuid)required

The team ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

A response including a single team.

Team

The team object contains information about a group of users.

idstring(uuid)read-only

The team ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The name of the team.

Match pattern:^[\w \W]+$

<= 250 characters

Example:IDM - Developers

descriptionstring

The team description in Konnect.

<= 250 characters

Example:The developers for the IDM API.

system_teambooleanread-only

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

Default:false

labelsobject

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 “_”.

Example:{"env":"test"}

created_atstring(date-time)read-only

A Unix timestamp representation of team creation.

Example:1992-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

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

Example:2022-02-07T17:00:00.52Z

get/teams/{teamId}
 
application/json

Update Team

Updates an individual team.

patch
https://global.api.konghq.com/v3/teams/{teamId}

Path Parameters

teamIdstring(uuid)required

The team ID

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

The request schema for the update team request.

namestring

The name of the team.

Match pattern:^[\w \W]+$

Example:IDM - Developers

descriptionstring

The description of the team.

<= 250 characters

Example:The Identity Management (IDM) API team.

labelsobject | null

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:{"env":"test"}

Response

application/json

A response including a single team.

Team

The team object contains information about a group of users.

idstring(uuid)read-only

The team ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestring

The name of the team.

Match pattern:^[\w \W]+$

<= 250 characters

Example:IDM - Developers

descriptionstring

The team description in Konnect.

<= 250 characters

Example:The developers for the IDM API.

system_teambooleanread-only

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

Default:false

labelsobject

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 “_”.

Example:{"env":"test"}

created_atstring(date-time)read-only

A Unix timestamp representation of team creation.

Example:1992-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

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

Example:2022-02-07T17:00:00.52Z

patch/teams/{teamId}

Body

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