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
Authentication Settings Response
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
Authentication Settings Response
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
List Identity Providers
Retrieves the identity providers available within the organization. This operation provides information about
various identity providers for SAML or OIDC authentication integrations.
Query Parameters
Filter identity providers returned in the response.
Show Child Parameters
Response
application/json
Response
A collection of identity providers. This response contains a collection of identity providers, which may include both OIDC and SAML identity providers.
Identity Provider Collection Response
The identity provider that contains configuration data for authentication integration.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Specifies the type of identity provider.
Allowed values:oidcsaml
Example:oidc
Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.
Default:false
Example:true
The path used for initiating login requests with the identity provider.
Example:myapp
One OfThe identity provider that contains configuration data for the OIDC authentication integration.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Query Parameters
Create Identity Provider
Creates a new identity provider. This operation allows the creation of a new identity provider for
authentication purposes.
Body
application/json
Body
An object representing the configuration for creating a new identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.
Create Identity Provider
The identity provider that contains configuration data for creating an authentication integration.
Specifies the type of identity provider.
Allowed values:oidcsaml
Example:oidc
Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.
Default:false
Example:true
The path used for initiating login requests with the identity provider.
Example:myapp
One OfThe identity provider that contains configuration data for the OIDC authentication integration.
Show Child Parameters
Response
application/json
Response
An identity provider configuration. This response represents the configuration of a specific identity provider, which can be either OIDC or SAML.
Identity Provider
The identity provider that contains configuration data for authentication integration.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Specifies the type of identity provider.
Allowed values:oidcsaml
Example:oidc
Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.
Default:false
Example:true
The path used for initiating login requests with the identity provider.
Example:myapp
One OfThe identity provider that contains configuration data for the OIDC authentication integration.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z