create_scim_workspace_mapping
Map an identity-provider SCIM group to a Portkey workspace role so current and future group members receive access automatically. Discover groups first, then assign the workspace and role.
Instructions
Map one identity-provider SCIM group to a Portkey workspace role so current and future group members receive access automatically. Provide exactly one of scim_group_id or scim_group_name; a name can pre-create the Portkey SCIM group before the IdP provisions it. Use list_scim_groups to discover existing groups and list_workspaces for the workspace ID. This changes access provisioning and is distinct from add_workspace_member, which grants one user directly. Enterprise-gated. Returns 403 on non-Enterprise Portkey plans.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workspace_id": "<workspace_id>",
"role": "<role>"
},
"name": "create_scim_workspace_mapping"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| role | Yes | Workspace role automatically granted to group members | |
| workspace_id | Yes | Portkey workspace ID that the SCIM group should access | |
| scim_group_id | No | Existing identity-provider SCIM group ID; provide this or scim_group_name, but not both | |
| scim_group_name | No | Existing SCIM group display name; provide this or scim_group_id, but not both |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | Call succeeded | |
| data | No | Success payload | |
| error | No | Failure details |