Auth Settings
Get Auth Settings
Returns authentication configuration, which determines how users can log in and how they are assigned to teams.
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
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