Patch Mappings by Team ID

Allows partial updates to the mappings between Konnect Teams and Identity Provider Groups.
The request body must be keyed on team ID. For a given team ID, the given group list is a
complete replacement. To remove all mappings for a given team, provide an empty group list.

Returns a 400 error if an Identity Provider has not yet been configured, or if a team ID in
the request body is not found or is not a UUID.

patch
https://global.api.konghq.com/v2/identity-provider/team-group-mappings

Body

application/json

The request schema for a partial update of mappings from Konnect Teams to IdP Groups.

dataarray[object]

The IdP groups to map to the given team.

Show Child Parameters

Response

application/json

A paginated collection of mappings grouped by team_id.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

A map of Konnect Team to IdP groups.

Example:{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]}

Show Child Parameters
patch/identity-provider/team-group-mappings

Body

{ "data": [ { "group": "Service Developers", "team_ids": [ "af91db4c-6e51-403e-a2bf-33d27ae50c0a" ] } ] }
 
application/json

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