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

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
organization
string
required

Organization ID

Body

application/json
New settings
​
auto_create_missing_groups
boolean

AutoCreateMissing controls whether groups returned by the OIDC provider are automatically created in Wirtual if they are missing.

​
field
string

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

​
legacy_group_name_mapping
object

LegacyNameMapping is deprecated. It remaps an IDP group name to a Wirtual group name. Since configuration is now done at runtime, group IDs are used to account for group renames. For legacy configurations, this config option has to remain. Deprecated: Use Mapping instead.

​
mapping
object

Mapping maps from an OIDC group --> Wirtual group ID

​
regex_filter
object

RegexFilter is a regular expression that filters the groups returned by the OIDC provider. Any group not matched by this regex will be ignored. If the group filter is nil, then no group filtering will occur.

Response

200 - application/json
OK
​
auto_create_missing_groups
boolean

AutoCreateMissing controls whether groups returned by the OIDC provider are automatically created in Wirtual if they are missing.

​
field
string

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

​
legacy_group_name_mapping
object

LegacyNameMapping is deprecated. It remaps an IDP group name to a Wirtual group name. Since configuration is now done at runtime, group IDs are used to account for group renames. For legacy configurations, this config option has to remain. Deprecated: Use Mapping instead.

​
mapping
object

Mapping maps from an OIDC group --> Wirtual group ID

​
regex_filter
object

RegexFilter is a regular expression that filters the groups returned by the OIDC provider. Any group not matched by this regex will be ignored. If the group filter is nil, then no group filtering will occur.