Get the IdP Configuration
Fetch the IdP configuration.
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
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.
Team Mapping Collection Response
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 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"]}