List Team Users

Returns a paginated list of users that belong to the team specified in the path parameter.

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

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 users returned in the response.

Show Child Parameters

Path Parameters

teamIdstring(uuid)required

ID of the team.

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

Response

application/json

A paginated list response for a collection of users.

User Collection Response

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

The user object contains information about an individual user who can use the Konnect application and API.

Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"Test User","preferred_name":"test","active":true,"inferred_region":"us","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"}

Show Child Parameters
get/teams/{teamId}/users
 
application/json

Add User

Adds a user to a team.

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

Path Parameters

teamIdstring(uuid)required

ID of the team.

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

Body

application/json

The request schema for adding a user to a team.

idstring(uuid)required

The user ID for the user being added to a team.

Example:df120cb4-f60b-47bc-a2f8-6a28e6a3c63b

Response

Created

post/teams/{teamId}/users

Body

{ "id": "df120cb4-f60b-47bc-a2f8-6a28e6a3c63b" }
 

Remove User

Removes a user from a team.
If the user was removed, returns a 204 empty response. Returns 404 if the user or team were not found.

delete
https://global.api.konghq.com/v3/teams/{teamId}/users/{userId}

Path Parameters

userIdstring(uuid)required

User ID

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

teamIdstring(uuid)required

Team ID.

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

Response

No Content

delete/teams/{teamId}/users/{userId}
 

List User Teams

Returns a paginated list of a teams that the user belongs to.

get
https://global.api.konghq.com/v3/users/{userId}/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

Path Parameters

userIdstring(uuid)required

The user ID.

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

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/users/{userId}/teams
 
application/json

Teams