Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/addUserPOST

...

WorkFlow: Add User Flow

Input

...

Type: application/json
Name
SourceMandatoryTypeSpecial FormatDescription
tIdtCodeBody or QueryYESStringN/Athe code of the tenant
Body or QueryYESStringN/Athe Id of the tenant where this user is added
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": "..."
}

...



Error Codes



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


Example (CURL)

...

Code Block
languagebash
titleCalling 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'

...