Versions Compared

Old Version 7

changes.mady.by.user Eliane Nassif (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

...

Workflow: 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
profileBodyNOObjectN/A
config

password
Body
bodyNO
Object
String
N/A


confirmation
Name
body
Source
NO
Mandatory
String
TypeSpecial FormatDescriptionkeysBodyYESObjectN/ApackagesBodyNOObjectN/ANameSourceMandatoryTypeSpecial FormatDescription%packageName%
Same Password Value
pin
bodyNO



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

allowed
NOBoolean

configBodyNOObjectN/A


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

allowedTenantsBodyNO
StringN/A
Array
array of allowedTenant objects


NameSourceMandatoryTypeSpecial FormatDescription
%apiRoute%
tenantBody
YESNameSourceMandatoryTypeSpecial FormatDescriptionaccess
NOObject
N/A

Properties:

  • id (String)
  • code (String)
  • pin (Object)
    • code (Boolean)
    • allowed (Boolean)
groupsBodyNO
Boolean or ArrayN/A
Array


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
}

...