List directory group role mappings | Clerk API (unofficial showcase)

1 parameter

directory_idstringrequired

The ID of the directory.

4 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.

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

Error handling

A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.groupRoleMappings.list({ directoryId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "data": [
    {
      "object": "directory_group_role_mapping",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "directory_id": "550e8400-e29b-41d4-a716-446655440000",
      "scim_directory_id": "550e8400-e29b-41d4-a716-446655440000",
      "directory_group_id": "550e8400-e29b-41d4-a716-446655440000",
      "scim_group_id": "550e8400-e29b-41d4-a716-446655440000",
      "directory_group_display_name": "Example Name",
      "scim_group_display_name": "Example Name",
      "role": {
        "object": "role",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Example Name",
        "key": "example_key_abc123",
        "description": "Example description",
        "is_creator_eligible": true,
        "permissions": [
          {
            "object": "permission",
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "name": "Example Name",
            "key": "example_key_abc123",
            "description": "Example description",
            "type": "standard",
            "created_at": 1,
            "updated_at": "2026-01-15T09:00:00Z"
          }
        ],
        "created_at": 1,
        "updated_at": "2026-01-15T09:00:00Z"
      },
      "precedence": 1,
      "created_at": 1,
      "updated_at": "2026-01-15T09:00:00Z"
    }
  ],
  "total_count": 42
}

Request

Response

Errors