Plane DocsSign in

Group sync overview ​

Group sync maps identity-provider groups onto Plane workspace and project roles.

The group mapping object ​

Attributes ​

  • auto_remove boolean

    Whether users are removed from the workspace or projects automatically when they are removed from their IdP group.

  • default_workspace_role_slug string

    The default workspace role slug.

  • group_attribute_key string

    The IdP claim key that holds group membership data, for example groups.

  • id string (uuid)

    Unique identifier.

  • is_enabled boolean

    Whether group sync is on for the workspace.

  • sync_offline boolean

    Whether sync can run outside of login events.

  • sync_on_login boolean

    Whether group memberships sync automatically when a user logs in.

  • updated_at string (date-time)

    When the group sync configuration was last updated.

Response200
json
{
  "auto_remove": false,
  "default_workspace_role_slug": "example",
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "group_attribute_key": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_enabled": false,
  "sync_offline": false,
  "sync_on_login": false
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/group-sync/project-mappings/List project mappings
GET/api/v2/workspaces/{slug}/group-sync/workspace-mappings/List workspace mappings
GET/api/v2/workspaces/{slug}/group-sync/config/Get the group sync configuration
GET/api/v2/workspaces/{slug}/group-sync/project-mappings/{pk}/Get a project mapping
GET/api/v2/workspaces/{slug}/group-sync/workspace-mappings/{pk}/Get a workspace mapping
POST/api/v2/workspaces/{slug}/group-sync/project-mappings/Create a project mapping
POST/api/v2/workspaces/{slug}/group-sync/workspace-mappings/Create a workspace mapping
PATCH/api/v2/workspaces/{slug}/group-sync/config/Update the group sync configuration
PATCH/api/v2/workspaces/{slug}/group-sync/project-mappings/{pk}/Update a project mapping
PATCH/api/v2/workspaces/{slug}/group-sync/workspace-mappings/{pk}/Update a workspace mapping
DELETE/api/v2/workspaces/{slug}/group-sync/project-mappings/{pk}/Delete a project mapping
DELETE/api/v2/workspaces/{slug}/group-sync/workspace-mappings/{pk}/Delete a workspace mapping

Response shaping ​

Every group mapping read accepts ?fields= for sparse responses. See Sparse fields. Errors follow the shared problem+json contract.