Versions Compared

Key

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

General Information

...

NameSourceMandatory

NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/A
usernameBodyYESStringalphanumeric with _ , - characters only
firstNameBodyYESStringN/A
lastNameBodyYESStringN/A
emailBodyYESStringN/A
statusBodyYESStringN/Aenum
'active', 'inactive'
restricted to either 'active' OR 'inactive'
groupsBodyNOArrayN/Aarray of group code values
profileBodyNOObjectN/A
configpasswordBodybodyNOObjectStringN/A

confirmationbodyNOStringTypeSpecial FormatDescriptionkeysBodyYESObjectN/ApackagesBodysame as password
configBodyNOObjectN/A


%packageName%accessBoolean or %apiRoute%YESaccessBoolean or N/A
NameSourceMandatoryTypeSpecial FormatDescription
keysBodyNOObjectN/A
NameSourceMandatoryTypeSpecial FormatDescriptionaclpackagesBodyNOObjectN/ANameSourceMandatoryTypeSpecial FormatDescription
allowedTenantsBodyNOArrayN/AapisPermissionBodyNOStringN/A
apisBodyNOObjectN/Aarray of allowed tenant objects


NameSourceMandatoryTypeSpecial FormatDescription
tenantBody
NOObject
N/ANameSourceMandatoryTypeSpecial FormatDescription


groupsBodyNO
Array





Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": true
}

...