v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Users

Create User

Invites a new user under the organization.

After making a REST API request, an invitation email is triggered and sent to the user. Upon receiving the invitation email, the user is required to click on a provided URL, which will redirect them to a page with a user interface (UI) where they can set their username and password.

The modification of any personal information related to a user can only be performed by the user through the UI. Similarly, the user can solely conduct password updates through the UI.

The "caller" possessing Organization Owner access rights retains the exclusive user creation capability. They hold the authority to assign roles at the organization and project levels.

At present, our support is limited to the resourceType of "project" exclusively.

In order to access this endpoint, the provided API key must have the following role:

  • Organization Owner

To learn more, see Organization Roles.

post/v4/organizations/{organizationId}/users

Request body

namestring

The name of the user.

emailstring required

Email of the user.

organizationRolesOrganizationRoles[] required

Example request

{
  "name": "John",
  "email": "john.doe@example.com",
  "organizationRoles": [
    "organizationOwner"
  ],
  "resources": []
}

Response

Successfully sent invite to the user.

idstring

The UUID of the user created.

Example response

{
  "id": "ffffffff-aaaa-1414-eeee-000000000000"
}