Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

General Information


ServiceAPIMethod
urac/admin/addUserPOST


Data Models: UsersTokens

Workflow: %Link to Architecture Page%

Input


NameSourceMandatoryTypeSpecial FormatDescription
tIdBody or QueryYESStringN/Athe Id of the tenant where this user is added
tCodeBody or QueryYESStringN/Athe code of the tenant
usernameBodyYESStringN/Aalphanumeric with _ , - characters only
firstNameBodyYESStringN/A 
lastNameBodyYESStringN/A 
emailBodyYESStringN/A 
profileBodyNOStringN/A 
groupsBodyNOArrayN/Aarray of group code values

 

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
402User account already exists.
403Unable to register user. please try again.
413Invalid profile field provided. Profile should be a stringified object.
414Unable to add user.
611invalid tenant id provided


Example (CURL)


Request

Calling YOUR 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

YOUR API response
{
	"result": true,
	"data": "719b0aed-edd8-47d5-ada0-9e5f93cb8247"
}
  • No labels