User Invitations API

The Inviations API is used to add and remove users from Projects. We use the terms grant and revoke to indicate permissions are being given and taken from users with the emails provided to the endpoints.

grant

POST /api/2/organizations/:organization_id/projects/:project_id/invitations/grant

Required Parameters

  • users array of strings, list of email addresses to invite to the project

Optional Parameters

  • read_only boolean, defaults to false, enabling gives user view-only access to project

Example Post Body

HTTP Status: 200 OK
{
  "users": ["readonly@example.com"],
  "read_only": "true"
}

revoke

POST /api/2/organizations/:organization_id/projects/:project_id/invitations/revoke

Required Parameters

  • users array of strings, list of email addresses whose project access should be revoked

Example Post Body

HTTP Status: 200 OK
{
  "users": ["readonly@example.com"]
}