Adding an Additional User within an Account (Sub-Account)

This guide explains how to create an additional user (sub-account) within your existing Volumez tenant using the provided API. This functionality allows you to manage user roles and access for streamlined account management.

Creating an Additional User

To add an additional user to your tenant, follow these steps:

1. API Endpoint

Use the following endpoint to create a new user:
POST /tenant/user

2. Required Parameters

Include the following in your API request body:

• email: The email address of the new user.

• password: The password for the new user.

• name: The full name of the user.

Example Request:

curl -X POST https://api.volumez.com/tenant/user \
-H 'content-type: application/json' \
-H 'authorization: <your_api_key>' \
-d '{
  "email": "mary.smith@gmail.com",
  "password": "ABc44567!!@",
  "name": "Mary Smith"
}'

3. Authentication

• Authorization Header: Include your API key in the authorization header to authenticate the request.

4. User Confirmation

After creating the user, they need to confirm their account using the confirmation API: POST /auth/userConfirm
Refer to the User Confirmation Documentation for details.

5. Adding a User Role

If your tenant uses roles, assign the new user an appropriate role using the addUser API:
POST /auth/addUser
Refer to the Add User Role Documentation.

6. Verify User Access

Once added, the user can log in with the credentials you provided. They will have access to resources based on the role and permissions assigned by the tenant.

Additional Information

• For more API details, refer to the Volumez Open API Documentation.

• Always ensure that passwords follow your organization’s security policies.

This process enables efficient management of user accounts, allowing for scalable and secure operations within your Volumez environment.