Sign in
Organizations

Add a user to an organization

Add a single existing account user to an organization with a specified role.

Payload Requirements

  • user_id and role are both required.
  • If the user is already a member, their role is updated to the specified value (upsert).

Role constraints

  • Users with an annotator account role can only be assigned the annotator organization role.
  • Users with a non-annotator account role cannot be assigned the annotator organization role.

Requires organization admin.

Valid example

{
  "user_id": "VXNlcjo0MjphQmNE",
  "role": "MEMBER"
}

Invalid example (annotator account user assigned non-annotator org role — returns 400)

{
  "user_id": "VXNlcjo0MjphQmNE",
  "role": "ADMIN"
}

<Note>This endpoint is in beta, read more here.</Note>

post/v2/organizations/{org_id}/users

Path parameters

org_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique organization identifier (base64)

Request body

user_idstring required

A universally unique identifier (base64-encoded opaque string).

Example request

{
  "user_id": "RW50aXR5OjEyMzQ1",
  "role": {
    "id": "RW50aXR5OjEyMzQ1"
  }
}

Response

User successfully added to the organization

idstring required

A universally unique identifier (base64-encoded opaque string).

user_idstring required

A universally unique identifier (base64-encoded opaque string).

organization_idstring required

A universally unique identifier (base64-encoded opaque string).

Example response

{
  "id": "RW50aXR5OjEyMzQ1",
  "user_id": "RW50aXR5OjEyMzQ1",
  "organization_id": "RW50aXR5OjEyMzQ1",
  "role": {
    "id": "RW50aXR5OjEyMzQ1"
  }
}

Changes

Changed in 1 of the 16 revisions of this API.13

  • 1e87d8a4cf6913See the full diff
    • ▲

      removed OrganizationPredefinedRoleAssignment OrganizationCustomRoleAssignment from the role request property oneOf list

      request-property-one-of-removed

    • ○

      mapped value for discriminator key CUSTOM changed from OrganizationCustomRoleAssignment to OrganizationCustomRoleAssignmentRequest for role request property

      request-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key PREDEFINED changed from OrganizationPredefinedRoleAssignment to OrganizationPredefinedRoleAssignmentRequest for role request property

      request-property-discriminator-mapping-changed

    • ○

      added OrganizationPredefinedRoleAssignmentRequest OrganizationCustomRoleAssignmentRequest to the role request property oneOf list

      request-property-one-of-added

Of the 16 revisions, 1 has no diff computed.