Versions Compared

Old Version 10

changes.mady.by.user Eliane Nassif (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

...

WorkFlow: Add User Flow

Input

...

Type: application/json
Name
SourceMandatoryTypeSpecial FormatDescription
tIdBody or QueryYESStringN/Athe Id of the tenant where this user is addedtCodeBody or QueryYES
StringN/Athe code of the tenant
usernameBodyYESStringalphanumeric with _ , - characters only
firstNameBodyYESStringN/A
lastNameBodyYESStringN/A
emailBodyYESString
N/A
Email Address Format (JSON Schema Validation)
profileBodyNOObjectN/AThe 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


403
Code
Description
400Database connection error
402User account already exists.
Unable to register user. please try again.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'

...