Group sync overview

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

The group mapping object

Attributes

• auto_remove boolean

  Whether auto remove.

• default_workspace_role_slug string

  The default workspace role slug.

• group_attribute_key string

  The group attribute key.

• id string (uuid)

  Unique identifier.

• is_enabled boolean

  Whether the rule is switched on.

• sync_offline boolean

  Whether sync offline.

• sync_on_login boolean

  Whether sync on login.

Response200

{
  "auto_remove": false,
  "default_workspace_role_slug": "example",
  "group_attribute_key": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_enabled": false,
  "sync_offline": false,
  "sync_on_login": false
}

Endpoints

Method	Path	Description
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.