Create workspace group mapping

POST/api/v1/workspaces/{workspace_slug}/group-sync/workspace-mappings/

Create a new IdP group → workspace role mapping.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

Body Parameters

idp_group_name:requiredstring

The name of the IdP group to map.

role:requiredstring

Workspace role slug to assign to members of the IdP group (e.g. member, admin).

Scopes

workspaces.group_sync:write

Create workspace group mapping

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "idp_group_name": "leadership",
  "role": "admin"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "idp_group_name": "leadership",
      "role": "admin"
    }
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/group-sync/workspace-mappings/", {
  method: "POST",
  headers: {
    "X-API-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    idp_group_name: "leadership",
    role: "admin",
  }),
});
const data = await response.json();

Response201

{
  "id": "772g0622-g41d-63f6-c938-668877662222",
  "idp_group_name": "leadership",
  "role": "admin",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}