Versions Compared

Key

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

General Information

...

Workflow: Edit User Flow

Input

...

...

  

NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/A 
usernameBodyYESStringalphanumeric with _ , - characters only 
firstNameBodyYESStringN/A 
lastNameBodyYESStringN/A 
emailBodyYESStringN/A 
statusBodyYESStringN/Arestricted to either 'active' OR 'inactive'
groupsBodyNOArrayN/Aarray of group code values
configprofileBodyNOObjectN/A
configBody NOObjectN/A


NameSourceMandatoryTypeSpecial FormatDescription
keysBodyYESObjectN/A 
packagesBodyNOObjectN/A 


 
 NameSourceMandatoryTypeSpecial FormatDescription
%packageName%BodyNOObject

N/A

 


 
 NameSourceMandatoryTypeSpecial FormatDescription
aclBodyNOObjectN/A 


 
 NameSourceMandatoryTypeSpecial FormatDescription
accessBodyNOBoolean or ArrayN/A 
apisPermissionBodyNOStringN/A 
apisBodyNOObjectN/A 


 
 NameSourceMandatoryTypeSpecial FormatDescription
%apiRoute%BodyYESObjectN/A  


 NameSourceMandatoryTypeSpecial FormatDescription
accessBodyNOBoolean or ArrayN/A 

 



Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": true
}

...


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[405],
        "details":[
            {
                "code":405,
                "message":"Unable to find User. Please try again."
            }
        ]
    }
}



Error Codes

 



Code
Description
405Unable to find User. Please try again.
407Problem validating Request. Please try again.
410username taken, please choose another username
411invalid user id provided
413Invalid profile field provided. Profile should be a stringified object.
415Unable to find group.
500This record in locked. You cannot modify or delete it

Example (CURL)

...