Sign in
Organization SSO

Enable organization SSO

Enable the SSO add-on and return a URL for verifying an email domain

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses manage_sso

OAuth Scopes

ResourceScopes
Organizationmanage_sso
post/organizations/{organization}/sso

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

Response

Returns organization SSO status and a domain verification URL

type'OrganizationSSO' required

The resource type

idstring required

The organization ID

enabledboolean required

Whether the SSO add-on is enabled for the organization

configuredboolean required

Whether an identity provider connection is active

directoryboolean required

Whether directory sync is enabled

has_verified_domainboolean required

Whether the organization has at least one verified email domain

domain_verification_urlstring nullable required

URL to open for verifying an email domain, returned when SSO is enabled

Changes