Versions Compared

Key

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

General Information

...

 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
configBodyNOObjectN/A 
 
packages
 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
}

...