Invites

Accept Invite

Accepts the Konnect invitation. This endpoint allows you to manually accept the invitation to join a Konnect organization. Upon accepting the invitation, the user’s name and password are set and the active state is set to true. This can be used as an alternative to the https://cloud.konghq.com/login link in the email which will finish the registration process in a web browser.

post
https://global.api.konghq.com/v2/accept-invite

Body

application/json

The request schema for the accept invite request.

passwordstring(password)required

Sets the password for the user.

Example:TestPassword123!!

full_namestringrequired

Full name of the user.

Example:James C. Woods

preferred_namestring | null

Preferred name of the user.

Example:Tiger

tokenstring(uuid)required

The one time token in accept-invitation link.

Example:7690d649-86fc-4d10-8771-c094d2efbd85

Response

Accepted

post/accept-invite

Body

{ "password": "TestPassword123!!", "full_name": "James C. Woods", "token": "7690d649-86fc-4d10-8771-c094d2efbd85" }
 

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.

post
https://global.api.konghq.com/v2/invites

Body

application/json

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.

emailstring(email)required

Example:james.c.woods@example.com

Response

Created

post/invites

Body

{ "email": "james.c.woods@example.com" }
 

Roles

Get Predefined Roles

Retrieves the predefined, or system managed, roles.

get
https://global.api.konghq.com/v2/roles

Response

application/json

The predefined, or system managed, roles.

runtime_groupsobject
* Additional properties are NOT allowed.
Show Child Parameters
servicesobject
* Additional properties are NOT allowed.
Show Child Parameters
audit_logsobject
* Additional properties are NOT allowed.
Show Child Parameters
identityobject
* Additional properties are NOT allowed.
Show Child Parameters
mesh_control_planesobject
* Additional properties are NOT allowed.
Show Child Parameters
dashboardsobject
* Additional properties are NOT allowed.
Show Child Parameters
reportsobject
* Additional properties are NOT allowed.
Show Child Parameters
get/roles
 
application/json