Versions Compared

Old Version 3

changes.mady.by.user peter eid (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Fadi Nasr (Unlicensed)

Saved on

Key

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

General Information

...

ServiceAPIMethod
urac/admin/editUserPOST


Data Models: Users, Groups

Workflow: %Link to Architecture Page% Edit User Flow

Input

...

Type: application/json

NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/A
 

usernameBodyYESStringalphanumeric with _ , - characters only
 

firstNameBodyYESStringN/A
 

lastNameBodyYESStringN/A
 

emailBodyYESString
N/A 
Email Address Format (JSON Schema Validation)
statusBodyYESString
N/A
- Enum
'active', 'inactive'
restricted to either 'active' OR 'inactive'
groupsBodyNOArray
N/A
Array of Stringsarray of group code values
config
profileBodyNOObjectN/A
 

password
 
body
 
NO
Name
String
Source


confirmation
Mandatory
body
Type
NO
Special FormatDescriptionkeysBodyYESObjectN/A packagesBodyNOObjectN/A   NameSourceMandatoryTypeSpecial FormatDescription%packageName% 
StringSame Password Value
pin
bodyNO



code
NOBooleanset to True to change pin to a random generated code 

allowed
NOBoolean

configBodyNOObjectN/A
  



NameSourceMandatoryTypeSpecial FormatDescription
acl NameSourceMandatoryTypeSpecial FormatDescriptionaccess
keysBodyNOObjectN/AAdditional Properties: acl (Object) 
 
packagesBodyNO
Boolean or Array
ObjectN/A
 

allowedTenants
apisPermission 
BodyNO
StringN/A apisBodyNOObjectN/A  
Array
array of allowedTenant objects


NameSourceMandatoryTypeSpecial FormatDescription
%apiRoute%
tenantBody
YES
NOObject
N/A  
 NameSourceMandatoryTypeSpecial FormatDescription
accessBodyNOBoolean or ArrayN/A 

...


Properties:

  • id (String)
  • code (String)
  • pin (Object)
    • code (Boolean)
    • allowed (Boolean)
groupsBodyNOArray


Example of config:

Code Block
languageactionscript3
titleconfig
 config: {
        packages: {},
        keys: {},
        allowedTenants: [
                {"tenant": {
                        id: "THYME_tID",
                        code: "THYME_CODE",
                        pin: {"code": "1235", "allowed": true}
                        },
                groups: ["waiter"]
                },
                {tenant: {
                        id: "ELVIRA_tID",
                        code: "ELVIRA_CODE"
                        },
                groups: ["manager]
                }
        ]
    },



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)

...

Request

Code Block
languagebash
titleCalling Edit User API
 > CURL -X POST http://127.0.0.1:4000/urac/admin/editUser?uId=123 -d 'username=john&firstName=John&lastName=Doe&email=johndoe@domain.com&status=active'

...