Add User

General Information

Service	API	Method
urac	/admin/addUser	POST

Data Models: Users, Tokens

WorkFlow: Add User Flow

Input

Name	Source	Mandatory	Type	Special Format	Description
tId	Body or Query	YES	String	N/A	the Id of the tenant where this user is added
tCode	Body or Query	YES	String	N/A	the code of the tenant
username	Body	YES	String	alphanumeric with _ , - characters only
firstName	Body	YES	String	N/A
lastName	Body	YES	String	N/A
email	Body	YES	String	N/A
profile	Body	NO	Object	N/A	The profile object.
groups	Body	NO	Array	N/A	array of group code values
status	body	NO	enum	'active', 'inactive', 'pendingNew'
password	body	NO	String
confirmation	body	NO	String	same as password

Output

Valid Response

Valid Response Sample

{
	"result": true,
	"data": "..."
}

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[402],
        "details":[
            {
                "code":402,
                "message":"User account already exists."
            }
        ]
    }
}

Error Codes

Code	Description
400	Database connection error
402	User account already exists.
414	Unable to add user.
611	invalid tenant id provided

Example (CURL)

Request

Calling Add User API

 > CURL -X POST http://127.0.0.1:4000/urac/admin/addUser?tId=5551aca9e179c39b760f7a1a&tCode=DBTN -d 'username=john&firstName=John&lastName=Doe&email=johndoe@domain.com'

Response

Add User API response

{
	"result": true,
	"data": {
		"id":"57c6eb28962f94a7caab8a22", 
		"token": "719b0aed-edd8-47d5-ada0-9e5f93cb8247"
	}
}