Skip to main content
PUT
Configure the organisation's identity provider

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

organisation_id
string<uuid>
required

Body

application/json
client_id
string
required
issuer
string
required
client_secret
string
write-only

Required when the connection is created and whenever the issuer or the client ID changes. Forwarded to the identity broker and stored nowhere in Ankra.

Response

Single sign-on settings

connection
OrganisationSSOConnection · object | null
required
domains
OrganisationSSODomain · object[]
required
group_mappings
OrganisationSSOGroupMapping · object[]
required
governed_member_count
integer
required
is_available
boolean
required
redirect_uri
string
required
sign_in_url
string | null
required

Sends somebody straight to the organisation's identity provider. Served on the portal origin, which proxies /auth/* to the API; null until a domain is verified.

suspended_member_count
integer
required