Sign in
latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-14249167721.0 KB

75df3a43fcb2

Directories

Create a directory group role mapping

Creates a new directory group to organization role mapping for a directory. Group role mapping must be enabled on the directory.

post/directories/{directory_id}/group_role_mappings

Path parameters

directory_idstring required

The ID of the directory.

Request body

directory_group_idstring

The group ID from the identity provider. Exactly one of directory_group_id or scim_group_id is required.

scim_group_idstring

The legacy name for directory_group_id. Send either one, or both with the same value; sending both with different values is rejected.

role_idstring required

The ID of the organization role to assign to members of the group.

precedenceinteger

The precedence for this mapping. Lower values take priority when a user belongs to multiple mapped groups. If omitted, the mapping is appended with the next-highest precedence.

Response

A directory group role mapping

object'directory_group_role_mapping' required

String representing the object's type. Always "directory_group_role_mapping".

idstring required

Unique identifier for the directory group role mapping.

directory_idstring required

The ID of the directory this mapping belongs to.

scim_directory_idstring required

The legacy name for directory_id. Carries the same value.

directory_group_idstring required

The group ID from the identity provider.

scim_group_idstring required

The legacy name for directory_group_id. Carries the same value.

directory_group_display_namestring required

The display name of the group, as reported by the identity provider.

scim_group_display_namestring required

The legacy name for directory_group_display_name. Carries the same value.

precedenceinteger required

Mapping precedence, starting at 1. Lower values take priority when a user belongs to multiple mapped groups.

created_atinteger required

Unix timestamp (milliseconds) of when the mapping was created.

updated_atinteger required

Unix timestamp (milliseconds) of when the mapping was last updated.