Get a Team Mapping
Fetch the IdP group to Konnect team mapping.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated list response for a collection of team mappings.
Team Mapping Response
Contains pagination data.
Show Child Parameters
Show Child Parameters
Authentication
Query Parameters
Get a Team Group Mappings
Retrieves the mappings between Konnect Teams and Identity Provider Groups.
Returns a 400 error if an Identity Provider has not yet been configured.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Response
application/json
Response
A paginated collection of mappings grouped by team_id.
Team Group Mapping Collection Response
returns the pagination information
Show Child Parameters
A map of Konnect Team to IdP groups.
Example:{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]}
Show Child Parameters
Authentication
Query Parameters
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.
Body
application/json
Body
The request schema for a partial update of mappings from Konnect Teams to IdP Groups.
The IdP groups to map to the given team.
Show Child Parameters
Response
application/json
Response
A paginated collection of mappings grouped by team_id.
Team Group Mapping Collection Response
returns the pagination information
Show Child Parameters
A map of Konnect Team to IdP groups.
Example:{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]}
Show Child Parameters
Authentication
Body
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.
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