Skip to main content
POST
/
scim
/
workspaces
curl -X POST https://api.portkey.ai/v1/scim/workspaces \
-H "x-portkey-api-key: PORTKEY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "scim_group_name": "Engineering Team",
    "workspace_id": "ws_my-workspace",
    "role": "member"
}'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "workspace_id": "ws-12345",
  "scim_group": "Engineering Team",
  "role": "member",
  "scim_group_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}

Documentation Index

Fetch the complete documentation index at: https://docs.portkey.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-portkey-api-key
string
header
required

Body

application/json
​
workspace_id
string
required

ID or slug (ws_ prefix) of the workspace to map the SCIM group to.

​
role
enum<string>
required

Role assigned to group members in the workspace.

Available options:
admin,
member,
manager
​
scim_group_id
string
required

ID of an existing SCIM group. Required if scim_group_name is not provided.

​
scim_group_name
string

Display name for the SCIM group. If the group doesn't exist, it will be created. Required if scim_group_id is not provided. Must not match the pattern-based auto-provisioning format (e.g. ws-name-role-admin).

Response

200 - application/json

OK

​
id
string

Unique ID of the mapping

​
workspace_id
string

ID of the mapped workspace

​
scim_group
string

Display name of the SCIM group

​
role
enum<string>

Role assigned to group members

Available options:
admin,
member,
manager
​
scim_group_id
string

ID of the SCIM group

Last modified on May 9, 2026