Skip to main content

`"describeAccounts"` (jsonAction)

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"
  },
  "apiVersion": "1.0",
  "requestId": "1",
  "debug": "max",
  "authToken": "replaceWithAuthTokenFromCreateSession"
}

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

describeAccountdescribeAccountsdescribe accountAPI actionJSON ADMIN APIjsonAction

`"params"`

Table 1. "params" property summaries

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

Would you like to provide feedback?