Versions Compared

Old Version 1

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 Model: %Link to Data Model%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
emailBodyYESStringEmail Address Format (JSON Schema Validation)
statusBodyYESString - Enum
'active', 'inactive'
restricted to either 'active' OR 'inactive'
groupsBodyNOArrayArray of Stringsarray of group code values
profileBodyNOObjectN/A
passwordbodyNOString

confirmationbodyNOStringSame Password Value
pin
bodyNO



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

allowed
NOBoolean

configBodyNOObjectN/A


NameSourceMandatoryTypeSpecial FormatDescription
keysBodyNOObjectN/AAdditional Properties: acl (Object) 
packagesBodyNOObjectN/A
allowedTenantsBodyNOArray
array of allowedTenant objects


NameSourceMandatoryTypeSpecial FormatDescription
tenantBodyNOObject

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":[400405],
        "details":[
            {
                "code":400405,
                "message":"Problem with the provided passwordUnable to find User. Please try again."
            }
        ]
    }
}



Error Codes

 


Code
Description
400Database Error
405Unable to find User. Please try again.
407Problem validating Request. Please try again.
410username taken, please choose another username
411invalid user id provided
415Unable to find group.
500This record in locked. You cannot modify or delete it

Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR 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'

Response

Code Block
languagejs
titleYOUR Edit User API response
{
	"result": true,
	"data": {
		"_id": "57063608622c47b5c097d19b",
		"..."
	}true
}