Update IdP Configuration
Update the IdP configuration.
Body
application/json
Body
The request schema for the update IdP configuration request.
Example:https://myidp.com/oauth2
Example:myapp
Example:YOUR_CLIENT_ID
Example:YOUR_CLIENT_SECRET
Default:openid
Show Child Parameters
Response
application/json
Response
A get action response of the IdP configuration.
IdP Configuration
The IdP object contains the configuration data for the OIDC authentication integration.
NOTE: The openid scope is required. Removing it could break the OIDC integration.
Example:https://myidp.com/oauth2
Example:myapp
Example:YOUR_CLIENT_ID
Default:email, openid, profile
Show Child Parameters
Authentication
Body
Update Team Mappings
Updates the IdP group to Konnect team mapping.
Body
application/json
Body
The request schema for updating IdP team mappings.
The mappings object.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of team mappings.
A team assignment is a mapping of an IdP group to a Konnect Team.
Example:{"group":"Service Developers","team_ids":["6801e673-cc10-498a-94cd-4271de07a0d3"]}
Show Child Parameters
Authentication
Body
Get the 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.
Contains pagination data.
Show Child Parameters
Show Child Parameters
Authentication
Query Parameters
Get the 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.
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.
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"]}