Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
idp-group-mappings

Creates or updates an individual IdpGroupMapping object (upsert operation).

Behavior:

  • If the mapping doesn't exist, it will be created with the provided values
  • If the mapping exists, only the fields provided in the request will be updated
post/idp-group-mappings/{app_resource_id}/groups/{group_id}

Path parameters

app_resource_idstring uuid required

The ID of the Okta app.

group_idstring uuid required

The ID of the group.

Request body

aliasstring nullable

Optional alias for the group mapping

hidden_from_end_userboolean nullable

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

The IDP group mapping was successfully created or updated.

app_resource_idstring uuid

The ID of the app resource.

group_idstring uuid required

The ID of the group.

aliasstring

The alias of the group.

hidden_from_end_userboolean required

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

Example response

{
  "app_resource_id": "1520617d-e72a-47f5-a84c-693817ab48ad2",
  "group_id": "6f99639b-7928-4043-8184-47cbc6766145",
  "alias": "finance-team",
  "hidden_from_end_user": false
}