OrganizationMembershipResource

Create an organization membership

Adds a user to an organization with a specified role.

Required API key permissions

  • Scope: organization-memberships:create
  • Accepted key types: organization API key (org-wide), personal access token (org-wide)
  • Access: Operates on a single organization. Pass organizationId when your API key spans multiple organizations.
  • Required organization role (user-linked keys only): Owner
  • Organization API keys are not subject to organization or team role checks.
post/api/public/v1/organization-membership

Request

Query parameters

organizationIdstring uuid
provisionboolean

When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.

Request body

userIdstring uuid nullable
emailstring email nullable
rolestring required

Response

OK

idstring uuid
organizationIdstring uuid
userIdstring uuid nullable
emailstring nullable
rolestring nullable
isProvisionedboolean

Changes

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