Skip to main content

"dropAccounts" (jsonAction)

Mark an account as dropped from the server

Links: Concepts | Tutorials | FAQs

Request examples

{
  "api": "admin"
  "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"
}

Use the dropAccounts API action to mark an account as dropped from the server

dropAccount
odpadnout
dropAccounts
drop account
API action
JSON ADMIN API
jsonAction

"params"

Table 1. "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

usernames

(optional) specifies the names of the accounts to be dropped

[]

array