List User Roles

Lists the roles assigned to a user. Returns 400 if any filter parameters are invalid.

get
https://global.api.konghq.com/v2/users/{userId}/assigned-roles

Query Parameters

filterobject

Filter roles returned in the response.

Show Child Parameters

Path Parameters

userIdstring(uuid)required

The user ID

Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe

Response

application/json

A paginated list response for a collection of assigned roles.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

An assigned role is a role that has been assigned to a user or team.

Example:{"id":"54cc6168-ebb1-4300-8168-d62a0dd08fc8","role_name":"Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Runtime Groups","entity_region":"us"}

Show Child Parameters
get/users/{userId}/assigned-roles
 
application/json

Assign Role

Assigns a role to a user. Returns 409 if role is already assigned.

post
https://global.api.konghq.com/v2/users/{userId}/assigned-roles

Path Parameters

userIdstring(uuid)required

The user ID

Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe

Body

application/json

The request schema for assigning a role.

An assigned role is a role that has been assigned to a user or team.

role_namestring

The desired role.

Example:Viewer

entity_idstring(uuid)

The ID of the entity.

Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a

entity_type_namestring

The type of entity.

Example:Runtime Groups

entity_regionstring

The region of the team.

Allowed values:useuaumeinsg*

Example:eu

Response

application/json

A get action response of a single assigned role.

AssignedRole

An assigned role is a role that has been assigned to a user or team.

idstring(uuid)

The ID of the role assignment.

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestring

Name of the role being assigned.

Example:Viewer

entity_idstring(uuid)

A RBAC entity ID.

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestring

Name of the entity type the role is being assigned to.

Example:Runtime Groups

entity_regionstring

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

post/users/{userId}/assigned-roles

Body

{ "role_name": "Viewer", "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61", "entity_type_name": "Runtime Groups", "entity_region": "us" }
 
application/json

Remove Role

Removes an assigned role from a user. Returns 404 if the requested user or assigned role were not found.

delete
https://global.api.konghq.com/v2/users/{userId}/assigned-roles/{roleId}

Path Parameters

userIdstring(uuid)required

ID of the user.

Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe

roleIdstring(uuid)required

ID of the role.

Example:8350205f-a305-4e39-abe9-bc082a80091a

Response

No Content

delete/users/{userId}/assigned-roles/{roleId}
 

Team Membership

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/v2/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.

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