Update Identity Provider
Updates the configuration of an existing identity provider. This operation allows modifications to be made
to an existing identity provider’s configuration.
Path Parameters
ID of the identity provider.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
An object representing the configuration for updating an identity provider. This configuration may pertain to either an OIDC or a SAML identity provider.
Update Identity Provider
The identity provider that contains configuration data for updating an authentication integration.
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
Authentication
Path Parameters
Body
Delete Identity Provider
Deletes an existing identity provider configuration. This operation removes a specific identity provider
from the organization.
Path Parameters
ID of the identity provider.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
Authentication
Path Parameters
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"]}