Skip to main content

`"dropAccounts"`

JSON ADMIN `"dropAccounts"` action marks an account as dropped from the server

The "dropAccounts" action marks an account as dropped from the server.

Request examples

{
  "api": "admin"
  "action": "dropAccounts",
  "params":
  {
    "usernames": [ "NewAccount1" ]
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}

Multiple accounts

{
  "api": "admin",
  "action": "dropAccounts",
  "params": {
    "usernames": [
      "NewAccount3",
      "NewAccount4"
    ]
  },
  "authToken": "replaceWithAuthTokenFromCreateSession",
  "requestId": "1"
}

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.

Successful response

{
  "authToken": "anAuthTokenFromCreateSession",
  "requestId": "00000004",
  "debugInfo": {
    "request": {
      "authToken": "anAuthTokenFromCreateSession",
      "api": "admin",
      "action": "dropAccounts",
      "params": {
        "usernames": [
          "NewAccount1"
        ]
      },
      "requestId": "1",
      "debug": "max"
    }
  },
  "errorCode": 0,
  "errorMessage": ""
}

Success on missing account response

{
  "authToken": "anAuthTokenFromCreateSession",
  "requestId": "1",
  "debugInfo": {
    "request": {
      "authToken": "anAuthTokenFromCreateSession",
      "api": "admin",
      "action": "dropAccounts",
      "params": {
        "usernames": [
          "NewAccount1"
        ]
      },
      "requestId": "1",
      "debug": "max"
    },
    "warnings": [
      {
        "code": 101,
        "message": "Not able to remove account [NEWACCOUNT1] - ISAM error [0]"
      }
    ]
  },
  "errorCode": 0,
  "errorMessage": ""
}

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

dropAccountdropAccountsdrop accountAPI actionJSON ADMIN APIjsonAction

Params

Table 1. account property summaries

Property	Description	Default	Type	Limits (inclusive)
usernames	specifies the names of the accounts to be dropped	`[]`	array