How to Add a New User to the User Management Server Using Bold BI REST API

Please refer to this document to get the authentication token.

1. Pass the access token generated from the token endpoint in the Authorization header.
   Authorization header included with the POST request



2. Create a new user using the following API endpoint.
   {base url}/api/v2.0/user/add

   METHOD	POST
   URL	/v2.0/user/add

   Post request to add a new user to the user management server passing authorization header
   
   

3. Include the following parameters in the body of the request in JSON format.
   

   Parameter Name	Type	Required	Comments
   username	String	Yes	Username of the user
   email	String	Yes	This value may be required based on the user account configuration.   The default value is yes.
   firstname	String	Yes	First name of the user
   lastname	String	Optional	Last name of the user
   password	String	Automatic Activation – Yes Email Activation - No	Password of the user. Based on the activation mode, the password parameter should be passed.

Note:

Password must contain:

1. At least 6 characters
2. 1 uppercase
3. 1 lowercase
4. 1 numeric
5. 1 special character
   

Sample POST Request

JSON data is included with the POST request to add a new user




4. ​You will get a response message with the new user information as follows.
   

   {
       "api_status": true,
       "data": {
           "user_id": "fd39e677-b5c8-49c5-b139-aa75c99e9770",
           "user_name": "John",
           "email": "john@syncfusion.com",
           "first_name": "John",
           "last_name": "Soundar",
           "display_name": "John Soundar",
           "contact": "",
           "directory_type": {
               "id": 1,
               "name": "Local"
           },
           "email_verified": true,
           "user_status": "Active",
           "avatar_url": null
       },
       "status": true,
       "status_message": "User has been added and activated successfully"
   }

5. The newly created user is visible on the UMS's users page.

   Users page in User Management Server with user details
   Refer to this document to learn more about managing users in UMS.