Sign in

v2

latestOpenAPI 3.0.12026-07-26334612609.5 KB
Organizations

Update SSO provider configuration

put/organizations/{organizationId}/ssoProvider/{ssoProviderId}

Path parameters

organizationIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of organization

ssoProviderIdstring uuid required

The SSO provider ID

Request body

clientIdstring

Client ID for the SSO provider

clientSecretstring

Client secret for the SSO provider

ssoDomainstring

SSO domain for the provider

emailDomainstring

Email domain for the company emails to be used for SSO

provider'okta'
enforceOnlySSOboolean

when set to true it would enforce sso auth to the domain

Response

Successfully updated SSO provider configuration

idstring required
clientIdstring required

Client ID for the SSO provider

maskedClientSecretstring required

Masked client secret for the SSO provider

organizationIdstring required
ssoDomainstring required

SSO domain for the provider

emailDomainstring required

Email domain for the company emails to be used for SSO

provider'okta' required
redirectUrlstring

Redirect URL for the SSO provider

enforceOnlySSOboolean required

Whether SSO is enforced for this domain

createdAtstring date-time required
updatedAtstring date-time required
ssoDomainVerifiedAtstring date-time

Timestamp when the SSO domain was verified by Dynamic API. This will be present when the SSO domain ownership has been verified by setting a TXT record in DNS.

ssoDomainVerificationChallengestring

TXT record challenge string for the SSO domain verification. This will be provided when the SSO provider domain ownership needs to be verified by setting a TXT record in DNS.

Example response

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "organizationId": "95b11417-f18f-457f-8804-68e361f9164f"
}