account

Get sso settings

Read the organization's single sign-on state: whether its identity provider connection is set up and active, its verified email domains, and whether single sign-on is required for them. The id is the organization id.

get/api/v1/account/sso-settings/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/account/sso-settings/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring required

The organization id

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

connection'none' | 'inactive' | 'active' required

The identity provider connection: none, set up but not signing anyone in yet, or active. While it is active, its verified domains sign in through it.

directory'none' | 'inactive' | 'active' required

The connected directory, in the same states.

domainsstring[] required

The verified email domains single sign-on governs.

enforceSsoboolean required

Whether those domains sign in only through the identity provider, whatever WorkOS's own settings say.

setupAvailableboolean required

Whether single sign-on can be set up: it needs an active paid subscription.

Changes

No recorded changes to this operation across all 1 revision of this API.