PATCH
/
settings
/
idpsync
/
organization
curl --request PATCH \
  --url https://cloud.local.wirtual.dev/api/v2/settings/idpsync/organization \
  --header 'Content-Type: application/json' \
  --header 'Wirtual-Session-Token: <api-key>' \
  --data '{
  "field": "<string>",
  "mapping": {},
  "organization_assign_default": true
}'
{
  "field": "<string>",
  "mapping": {},
  "organization_assign_default": true
}

Authorizations

​
Wirtual-Session-Token
string
header
required

Body

application/json
New settings
​
field
string

Field selects the claim field to be used as the created user's organizations. If the field is the empty string, then no organization updates will ever come from the OIDC provider.

​
mapping
object

Mapping maps from an OIDC claim --> Wirtual organization uuid

​
organization_assign_default
boolean

AssignDefault will ensure the default org is always included for every user, regardless of their claims. This preserves legacy behavior.

Response

200 - application/json
OK
​
field
string

Field selects the claim field to be used as the created user's organizations. If the field is the empty string, then no organization updates will ever come from the OIDC provider.

​
mapping
object

Mapping maps from an OIDC claim --> Wirtual organization uuid

​
organization_assign_default
boolean

AssignDefault will ensure the default org is always included for every user, regardless of their claims. This preserves legacy behavior.