Workspace

Create a project group mapping

Map an identity provider group to a Plane role within one project.

post/workspaces/{workspace_slug}/group-sync/project-mappings/

Request

  • Base URL: https://api.plane.so/api/v1
  • URL: https://api.plane.so/api/v1/workspaces/{workspace_slug}/group-sync/project-mappings/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.plane.so/auth/o/authorize-app/, token URL https://api.plane.so/auth/o/token/; client credentials, token URL https://api.plane.so/auth/o/token/, scopes: workspaces.group_sync:write)

Path parameters

workspace_slugstring required

Workspace identifier from the workspace URL. In https://app.plane.so/my-team/projects/ it is my-team.

Request body

idp_group_namestring required
rolestring required

Project role to grant members of that group.

project_idstring uuid required

Response

The created project group mapping.

idstring uuid required
idp_group_namestring

Group name as it appears in the identity provider.

rolestring

Plane role granted to members of that group.

project_idstring uuid nullable

Set on project mappings only.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.