Create user

Create a user within an organization.

Note: POST calls create new data, and do not affect existing data.

Request
Security:
bearerAuth
path Parameters
orgId
required
string

The ID of the organization. Obtain this from GET /organizations.

Example: 62
Request Body schema: application/json
email
required
string <email> (Email) ^\S+@\S+\.\S{2,}$

The email address of the entity.

password
required
string <password> (Password) >= 8 characters

The password must contain at least eight characters, including one upper-case letter, one lower-case letter, and one number. The password may consist of a combination of letters, numbers, and special characters.

role
required
string (Role)

The role of the entity.

Enum: "restricted" "user" "administrator" "supervisor"
groupIds
Array of integers (Group ID) unique

The IDs of the requested groups.

Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

post/organizations/{orgId}/users
Request samples
application/json
{
  • "email": "email@email.com",
  • "password": "123Abcd!",
  • "role": "restricted",
  • "groupIds": [
    ]
}
Response samples
    1 more
    500
application/json
{
  • "requestId": "df5fg-45fgfdsg-45fg-45454",
  • "userId": 32
}