PUT - /admin/user

General Information

Service	API	Method	Data Models	Workflow
urac	/admin/user	PUT	Users & Groups	Edit User Flow

Description

This API updates a user record that matches the id sent in the query.

Input

Type: application/json

	Source	Mandatory	Type	Special Format	Description
id	Body	YES	String	N/A	User ID
username	Body	NO	String	alphanumeric with _ , - characters only	Username
firstName	Body	NO	String	N/A	First Name
lastName	Body	NO	String	N/A	Last Name
email	Body	NO	String	Email Address Format (JSON Schema Validation)	Email
status	Body	NO	String	'active', 'inactive' , 'pendingNew'	restricted to either 'active', 'inactive', or 'pendingNew'
groups	Body	NO	Array	Array of Strings	array of group code values
profile	Body	NO	Object	N/A	Profile
ln	Body	NO	String		language
phone	Body	NO	String		Phone number

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": true
}

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
602	Model error: + %model_error%