Post idp group mappings groups - Opal Security Docs

curl --request POST \ --url https://api.opal.dev/v1/idp-group-mappings/{app_resource_id}/groups/{group_id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "alias": "<string>", "hidden_from_end_user": true } '

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_resource_id

string<uuid>

required

The ID of the Okta app.

group_id

string<uuid>

required

The ID of the group.

Body

application/json

alias

string | null

Optional alias for the group mapping

hidden_from_end_user

boolean | null

Whether this mapping should be hidden from end users.

New mappings: If not provided, defaults to false
Existing mappings: If not provided, existing value is preserved (no change)
Explicit values: If provided, value is updated to the specified boolean

Response

200 - application/json

The IDP group mapping was successfully created or updated.

Information about a group mapping.

group_id

string<uuid>

required

The ID of the group.

Example:

"6f99639b-7928-4043-8184-47cbc6766145"

hidden_from_end_user

boolean

required

A bool representing whether or not the group is hidden from the end user.

Example:

false

app_resource_id

string<uuid>

The ID of the app resource.

Example:

"1520617d-e72a-47f5-a84c-693817ab48ad2"

alias

string

The alias of the group.

Example:

"finance-team"