Users

Create a new user

Add a new team member to your Account with just a few steps. You can create accounts for colleagues, clients, or contractors, and control exactly what they can access by assigning specific roles. The new user will receive immediate access to your system based on the permissions you grant them.

Key Parameters:

  • email: Email address for the new user
  • password: Initial password for the user's account
  • role: Access level to assign (e.g., 'Administrator' for admin level access, 'Full' for complete access, 'Readonly' for limited access, 'custom' for customizing access level)

NOTE: You must have administrator privileges to add new users. Choose a strong password for security, and be mindful of the role you assign as it determines what actions the user can perform.

post/users

Request

  • Base URL: https://api.cloudpepper.io
  • URL: https://api.cloudpepper.io/users
  • Auth: HTTP bearer

Request body

emailstring required

Email address for the new user account

passwordstring required

Initial password for the user account

rolestring required

Role to assign to the user within the tenant

Example request

{
  "email": "newuser@example.com",
  "password": "SecureP@ssword123",
  "role": "USER"
}

Response

User created successfully

uidstring

Unique identifier for the newly created user

Changes

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