System Accounts - Team Membership

List System Accounts on a Team

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

get
https://global.api.konghq.com/v2/teams/{teamId}/system-accounts

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

Show Child Parameters

Path Parameters

teamIdstringrequired

ID of the team.

Response

application/json

A paginated list response for a collection of system accounts.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

Schema of the system account.

Example:{"id":"497f6eca-6276-4993-bfeb-53cbbbba6f08","name":"Example System Account","description":"This is a sample system account description.","created_at":"2022-08-24T14:15:22Z","updated_at":"2022-10-05T10:33:49Z","konnect_managed":false}

Show Child Parameters
get/teams/{teamId}/system-accounts
 
application/json

Add System Account to a Team

Adds a system account to a team. Returns a 409 if the system account is already a member of the team.

post
https://global.api.konghq.com/v2/teams/{teamId}/system-accounts

Path Parameters

teamIdstringrequired

ID of the team.

Body

application/json

The request schema for adding a system account to a team.

idstring(uuid)

ID of the system account.

Response

Created

post/teams/{teamId}/system-accounts

Body

{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }
 

Remove System Account From Team

Removes a system account from a team. Returns 404 if the team or system account were not found.

delete
https://global.api.konghq.com/v2/teams/{teamId}/system-accounts/{accountId}

Path Parameters

teamIdstringrequired

ID of the team.

accountIdstringrequired

ID of the system account.

Response

No Content

delete/teams/{teamId}/system-accounts/{accountId}
 

List Teams for a System Account

Returns a paginated list of a teams that the system account belongs to.

get
https://global.api.konghq.com/v2/system-accounts/{accountId}/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

accountIdstringrequired

ID of the system account.

Response

application/json

A paginated list response for a collection of users.

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,"created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-08-31T17:00:00.52Z"}

Show Child Parameters
get/system-accounts/{accountId}/teams
 
application/json