Versions Compared

Key

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

...

workflow: Edit User Config Flow

Input

...

Type: application/json

NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/Athe user id
configBodyYESObjectN/A  


 aclaccessBoolean or

 NameSourceMandatoryTypeSpecial FormatDescription
keysBodyYESNOObjectN/A 
packagesBodyNOObjectN/A  
 NameSourceMandatoryTypeSpecial FormatDescription
%packageName%Additional Properties: acl (Object)
allowedTenantsBodyNOObject

N/A

 

 


NameSourceMandatoryTypeSpecial FormatDescription
tenantBodyNOObject
N/A

Properties:  

 
 NameSourceMandatoryTypeSpecial FormatDescription
  • id (String)
  • code (String)
  • pin (Object)
    • code (String)
    • allowed (Boolean)
groupsBodyNO
Array
N/A 
apisPermissionBodyNOStringN/A 
apisBodyNOObjectN/A 
 
 NameSourceMandatoryTypeSpecial FormatDescription
%apiRoute%BodyYESObjectN/A 
 
 NameSourceMandatoryTypeSpecial FormatDescription
accessBodyNOBoolean or ArrayN/A 

 




example 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.
411invalid user id provided
500This record in locked. You cannot modify or delete it


Example (CURL)

...