Update Auth Settings
Updates authentication configuration.
Body
application/json
Body
The request schema to update an organization’s authentication settings.
The organization has basic auth enabled.
Example:true
The organization has OIDC disabled.
Example:false
The organization has SAML disabled.
Example:false
Whether IdP groups determine the Konnect teams a user has.
Example:true
Whether a Konnect Identity Admin assigns teams to a user.
Example:false
Response
application/json
Response
Response for authentication settings endpoint
The organization has basic auth enabled.
Example:true
The organization has OIDC disabled.
Example:false
The organization has SAML disabled.
Example:false
IdP groups determine the Konnect teams a user has.
Example:true
A Konnect Identity Admin assigns teams to a user.
Example:false
Authentication
Body
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.
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.