Provision a partner SSO platform account

Provisions a complete platform (payer) account under the organization for partner single sign-on: the payer user, the organization account link carrying the partner external id, and the SSO authentication settings for the given domain. The WorkOS connection is derived from the organization's existing SSO settings. The operation is idempotent; replaying it reports which resources already existed. May be performed by the organization itself, its direct parent or organization root, or a user holding an active authorization on the organization (or an inclusive-descendants authorization on one of its ancestors).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the organization to provision under

Body Params
string
required

Partner-side identifier for the platform account (e.g. Asset ID)

string
required

SSO domain the authentication settings apply to

string
required

The partner's SSO-profile alias for the external id — the profile attribute whose value carries the platform account's externalId at sign-in (e.g. AssetID)

string

Email for the payer user; defaults to admin@{domain}

attributeMapping
object
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json