Clerk API (unofficial showcase)
PUT/directories/{directory_id}/group_role_mappings

Replace directory group role mappings

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.

1 parameter · 1 body field
directory_idstringrequired
The ID of the directory.
mappingsarray<object>required
The desired set of mappings. Array order sets precedence (1-indexed). An empty array clears all mappings.

6 status codes
200A list of directory group role mappings, ordered by precedence.
dataarray<object>required
total_countintegerrequired
Total number of directory group role mappings in the directory.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Authorization invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters.