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

Team Group Mapping Collection Response

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": [ { "team_id": "af91db4c-6e51-403e-a2bf-33d27ae50c0a", "groups": [ "Service Developers" ] } ] }
 
application/json

Invites

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/v3/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/v3/roles

Response

application/json

The predefined, or system managed, roles.

Roles Response

control_planesobject
* Additional properties are NOT allowed.
Show Child Parameters
api_productsobject
* 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