Delete a workspace mapping

DELETE/api/v2/workspaces/{slug}/group-sync/workspace-mappings/{pk}/

Group sync maps identity-provider groups onto Plane workspace and project roles. Delete a workspace mapping. A successful delete returns 204 with an empty body.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The workspace mapping id.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: created_at, id, idp_group_name, role_slug.

Scopes

workspaces.group_sync:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	A business rule blocks the write — see the notes above.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Delete a workspace mapping

curl -X DELETE \
  "https://api.plane.so/api/v2/workspaces/my-team/group-sync/workspace-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.delete(
    "https://api.plane.so/api/v2/workspaces/my-team/group-sync/workspace-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.status_code)

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/group-sync/workspace-mappings/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "DELETE",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
console.log(response.status);

Response204

No response body.

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No workspace mapping matches the given query."
}