List SCIM Workspace Mappings

List all mappings between SCIM groups and workspaces for the organisation. Optionally filter by workspace, SCIM group, or role.

GET /scim/workspaces

cURL

Default

curl -X GET https://api.portkey.ai/v1/scim/workspaces \ -H "x-portkey-api-key: PORTKEY_API_KEY"

200

{
  "mappings": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "workspace_id": "ws_my-workspace",
      "scim_group": "Engineering Team",
      "scim_group_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "role": "member"
    }
  ],
  "total_count": 1
}

The response is paginated. The query parameters page (zero-indexed) and page_size control pagination, and the response includes a total_count field reflecting the total number of mappings across all pages.

When a SCIM group is mapped to multiple workspaces, the list contains one entry per (group, workspace) pair. Filter by workspaceId, scimGroupId, or role to narrow results.

Authorizations

x-portkey-api-key · string · header · required

Query Parameters

workspace_id · string

Filter mappings by workspace ID or slug.

scim_group_id · string

Filter mappings by SCIM group ID.

role · enum<string>

Filter mappings by role.

Available options: admin, member, manager

Response

200 - application/json

OK

mappings · object[]

Show child attributes

total_count · integer

Total number of mappings returned.