Skip to content

Configure Oidc Sso

PUT
/org/sso/oidc

Configure OIDC sign-in. Does NOT switch it on - see /activate.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

OIDC sign-in configuration.

client_secret is write-only in effect: the app stores it and the read endpoint does not hand it back.

object
allowed_domains
Any of:
Array<string>
authorize_url
required
string
client_id
required
string
client_secret
required

Stored, never returned by the read endpoint.

string
provider_name
required

IdP name: okta, azure, google, custom.

string
require_sso

See the SAML note — set this later.

boolean
token_url
required
string
userinfo_url
required
string

Responses

200

Successful Response

object
data
required

An open envelope for a settings object.

Open because an ontology concept and an SSO config both grow fields as the product does, and on a settings read a dropped field reads as “not configured” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string