Add User

General Information

Service	API	Method	Data Models	Workflow
urac	/admin/user	POST	Users	N/A

Description

This API adds a user record to the tenant that has the external key sent in the request headers.

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

username

Body

YES

String

N/A

Username

password

Body

NO

String

N/A

Password

email

Body

YES

String

Email format

Email

firstName

Body

YES

String

N/A

First Name

lastName

Body

YES

String

N/A

Last Name

profile

Body

NO

Object

N/A

Profile Object

status

Body

NO

String

active, inactive, or pendingNew

User Status

Body

NO

Object

includes code and allowed

Pin Object

Name	Mandatory	Type	Description
code	YES	Boolean	set to True to create a random generated code
allowed	YES	Boolean	set to True if this user is allowed to start pin code login

groups

Body

NO

Array

Array of Strings

Groups array

Output

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response

Valid Response

Valid Response Sample

{ result: true, data: { id: '%new_user_ID%' } }

Invalid Response

Error Response Sample

{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

Code	Description
400	Business logic required data are missing
525	Unable to generate pin at this time
602	Model error: + %model_error%

Add User

[data-colorid=os45hu9hrs]{color:#091e42} html[data-color-mode=dark] [data-colorid=os45hu9hrs]{color:#bdd2f6}General Information

Description

Input

Output

Response

Valid Response

Invalid Response

Response schema

SOAJS Error Codes

General Information