Skip to main content

`"describeAccounts"`

JSON ADMIN `"describeAccounts"` action describes roles that the account is authorized to see

The "describeAccounts" action describes specified roles that the account is authorized to see.

Request examples

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

Maximal

{
  "api": "admin",
  "action": "describeAccounts",
  "params": {
    "usernames": [
      "admin",
      "NewAccount1"
    ]
  },
  "responseOptions": {
    "binaryFormat": "hex",
    "dataFormat": "objects",
    "numberFormat": "string"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession",
  "apiVersion": "1.0",
  "requestId": "1",
  "debug": "max"
}

Use the describeAccounts API action to describe specifies roles that the account is authorized to see

describeAccountdescribeAccountsdescribe accountAPI actionJSON ADMIN APIjsonAction

Params

Table 1. account property summaries

Property	Description	Default	Type	Limits (inclusive)
usernames	specifies the names of the accounts you want to see more details about	`[]`	array