Request examples
Minimal
{
"action": "describeAccounts",
"params": {
"usernames": [
"admin"
]
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}Maximal
{
"api": "admin",
"action": "describeAccounts",
"params": {
"usernames": [
"admin",
"NewAccount1"
]
},
"responseOptions": {
"binaryFormat": "hex",
"dataFormat": "objects",
"numberFormat": "string"
},
"apiVersion": "1.0",
"requestId": "1",
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Response example
{
"username": "johndoe",
"accountDescription": "",
"lockoutAfterNFailedAttempts": 0,
"maxDaysBeforePasswordMustChange": 0,
"maxMinutesBeforeNextLogin": 0,
"memoryLimit": 0,
"memoryRule": "default",
"lastPasswordChange": "2026-01-26T22:21:29"
}
Properties
Request properties ("params")
| Property | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
usernames |
The "usernames" property specifies the names of the accounts that the action will target. |
Optional with default of []
|
array | 0 or more usernames, each between 1 and 64 bytes. |