Versions Compared

Old Version 3

changes.mady.by.user peter eid (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ragheb Bou Dargham (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

ServiceAPIMethod
urac/admin/addUserPOST


Data Models: Users, Tokens

Workflow: %Link to Architecture Page%

...

WorkFlow: Add User Flow

Input

...

Type: application/json
Name
SourceMandatoryTypeSpecial FormatDescription
tIdBody or QueryYESStringN/Athe Id of the tenant where this user is added
tCodeBody or QueryYESStringN/Athe code of the tenant
usernameBodyYESStringalphanumeric with _ , - characters only
 

firstNameBodyYESStringN/A
 

lastNameBodyYESStringN/A
 

emailBodyYESString
N/A 
Email Address Format (JSON Schema Validation)
profileBodyNO
String
ObjectN/A
a stringified
The profile object.
groupsBodyNOArrayN/Aarray of group code values

...

statusbodyNOString - enum
'active', 'inactive', 'pendingNew'

passwordbodyNOString

confirmationbodyNOStringValue is as same as password
pin
bodyNO



code
YESString


allowed
YESboolean


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": "..."
}

...


Invalid Response
 Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[402],
        "details":[
            {
                "code":402,
                "message":"User account already exists."
            }
        ]
    }
}


Error Codes

 
Code
Description
400Database connection error
402User account already exists
.403Unable to register user. please try again
.
413
Invalid profile field provided. Profile should be a stringified object.
414Unable to add user.
611invalid tenant id provided

Example (CURL)
...
Request
 Code Block
languagebash
titleCalling YOUR 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'
...
 Code Block
languagejs
titleYOUR Add User API response
{
	"result": true,
	"data": {
		"id":"57c6eb28962f94a7caab8a22", 
		"token": "719b0aed-edd8-47d5-ada0-9e5f93cb8247"
	}
}