latestOpenAPI 3.1.02026-08-233001841.3 MB

0dcf3303e9d7

memberships

Create a membership

Ensures an active membership for the given email will be provisioned.

  • If the user already exists, they will be added to the requestor's organization.
  • If it doesn't exist, a new user will be provisioned.

This request requires "Manage Organization" permissions.

As a security precaution, this operation requires the organization to have the "Restrict new users to emails from these domains" setting enabled, and the new member's email address must belong to one of its verified domains.

post/membership/

Request body

emailstring email required
role_idstring required

One of superuser, user, or restricteduser for the corresponding predefined role, or the ID of a custom Role. The role must not grant the manage_organization permission.

Response

Successful response