Skip to main content
PUT
/
organizations
/
{organizationId}
/
ssoProvider
/
{ssoProviderId}
Update SSO provider configuration
curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/organizations/{organizationId}/ssoProvider/{ssoProviderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "<string>",
  "clientSecret": "<string>",
  "ssoDomain": "<string>",
  "emailDomain": "<string>",
  "enforceOnlySSO": true
}
'
{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "clientId": "<string>",
  "maskedClientSecret": "<string>",
  "organizationId": "95b11417-f18f-457f-8804-68e361f9164f",
  "ssoDomain": "<string>",
  "emailDomain": "<string>",
  "enforceOnlySSO": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "redirectUrl": "<string>",
  "ssoDomainVerifiedAt": "2023-11-07T05:31:56Z",
  "ssoDomainVerificationChallenge": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required

ID of organization

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
ssoProviderId
string<uuid>
required

The SSO provider ID

Body

application/json
​
clientId
string

Client ID for the SSO provider

Maximum string length: 255
​
clientSecret
string

Client secret for the SSO provider

Maximum string length: 255
​
ssoDomain
string

SSO domain for the provider

Maximum string length: 255
​
emailDomain
string

Email domain for the company emails to be used for SSO

Maximum string length: 255
​
provider
enum<string>
Available options:
okta
​
enforceOnlySSO
boolean

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

Response

Successfully updated SSO provider configuration

​
id
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
clientId
string
required

Client ID for the SSO provider

​
maskedClientSecret
string
required

Masked client secret for the SSO provider

​
organizationId
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
ssoDomain
string
required

SSO domain for the provider

​
emailDomain
string
required

Email domain for the company emails to be used for SSO

​
provider
enum<string>
required
Available options:
okta
​
enforceOnlySSO
boolean
required

Whether SSO is enforced for this domain

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
redirectUrl
string

Redirect URL for the SSO provider

​
ssoDomainVerifiedAt
string<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.

​
ssoDomainVerificationChallenge
string

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.