Request examples
Minimal
{
"action": "dropAccounts",
"params":
{
"usernames": [ "NewAccount1" ]
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}Multiple accounts
{
"api": "admin",
"action": "dropAccounts",
"params": {
"usernames": [
"NewAccount3",
"NewAccount4"
]
},
"requestId": "1",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Response examples
Note If the target object does not exist, the response returns success, and the debug property contains a warning that the object was not found.
Success
{
"requestId": "00000004",
"debugInfo": {
"request": {
"api": "admin",
"action": "dropAccounts",
"params": {
"usernames": [
"NewAccount1"
]
},
"requestId": "1",
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}Success on missing account
{
"requestId": "1",
"debugInfo": {
"request": {
"api": "admin",
"action": "dropAccounts",
"params": {
"usernames": [
"NewAccount1"
]
},
"requestId": "1",
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
},
"warnings": [
{
"code": 101,
"message": "Not able to remove account [NEWACCOUNT1] - ISAM error [0]"
}
]
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
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. |