Register SSO Provider

This endpoint is used to register an OIDC provider. This is used to configure the provider and link it to an organization

Authentication

AuthorizationBearer
Bearer token authentication

Request

This endpoint expects an object.
providerIdstringRequired
The ID of the provider. This is used to identify the provider during login and callback
issuerstringRequired
The issuer URL of the provider
domainstringRequired

The domain(s) of the provider. For enterprise multi-domain SSO where a single IdP serves multiple email domains, use comma-separated values (e.g., ‘company.com,subsidiary.com,acquired-company.com’)

oidcConfigobject or nullOptional
samlConfigobject or nullOptional
organizationIdstring or nullOptional
If organization plugin is enabled, the organization id to link the provider to
overrideUserInfoboolean or nullOptionalDefaults to false
Override user info with the provider info. Defaults to false

Response

OIDC provider created successfully
issuerstringformat: "uri"
The issuer URL of the provider
domainstring
The domain of the provider, used for email matching
oidcConfigobject
OIDC configuration for the provider
userIdstring
ID of the user who registered the provider
providerIdstring
Unique identifier for the provider
redirectURIstringformat: "uri"
The redirect URI for the provider callback
domainVerifiedboolean
A boolean indicating whether the domain has been verified or not
domainVerificationTokenstring
Domain verification token. It can be used to prove ownership over the SSO domain
organizationIdstring or null
ID of the linked organization, if any

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error