Invite User
Sends an invitation email to invite a user to the Konnect organization. The email contains a link with a one time token to accept the invitation. Upon accepting the invitation, the user is directed to https://cloud.konghq.com/login to complete registration.
Body
application/json
Body
The request schema for the invite user request.
If you pass an email that is not already an active user in the request, a fresh invitation email will be created and sent to the new user.
Example:james.c.woods@example.com
Response
Response
Created
Authentication
Body
Roles
Get Predefined Roles
Retrieves the predefined, or system managed, roles.
Response
application/json
Response
The predefined, or system managed, roles.
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Show Child Parameters
Authentication
List Team Roles
Lists the roles belonging to a team.
Query Parameters
Filter roles returned in the response. Returns 400 if any filter parameters are invalid.
Show Child Parameters
Path Parameters
The team ID
Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe
Response
application/json
Response
A paginated list response for a collection of assigned roles.
returns the pagination information
Show Child Parameters
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
Authentication
Path Parameters
Query Parameters
Assign Role
Assigns a role to a team. Returns 409 if role is already assigned.
Path Parameters
The team ID
Example:e81bc3e5-e9db-4764-b7dd-e81e39072cbe
Body
application/json
Body
The request schema for assigning a role.
An assigned role is a role that has been assigned to a user or team.
The desired role.
Example:Viewer
The ID of the entity.
Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a
The type of entity.
Example:Runtime Groups
The region of the team.
Allowed values:useuaumeinsg*
Example:eu
Response
application/json
Response
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.
The ID of the role assignment.
Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67
Name of the role being assigned.
Example:Viewer
A RBAC entity ID.
Example:817d0422-45c9-4d88-8d64-45aef05c1ae7
Name of the entity type the role is being assigned to.
Example:Runtime Groups
Region of the entity.
Allowed values:useuaumeinsg*
Example:eu