CLclerk
Directories

Replace directory group role mappings

Changed on

Replaces the entire set of directory group role mappings for a directory. The position of each item in the mappings array determines its precedence (the first item gets precedence 1). Passing an empty array removes all mappings. Mappings can be replaced while group role mapping is disabled on the directory, but they only take effect once it is enabled.

put/directories/{directory_id}/group_role_mappings

Request

  • Base URL
    https://api.clerk.com/v1
  • URL
    https://api.clerk.com/v1/directories/{directory_id}/group_role_mappings
  • Auth
    HTTP bearer

Path parameters

directory_idstring required

The ID of the directory.

Request body

Response

A list of directory group role mappings, ordered by precedence.

total_countinteger required

Total number of directory group role mappings in the directory.

Changes