Skip to main content

`"describeAccounts"` (JSON Action)

Describe roles that the account is authorized to see

Links: Concepts | Tutorials | FAQs

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

describeAccountvysletlitdescribeAccountsdescribe accountAPI actionJSON ADMIN APIJSON Action

`"params"`

Table 1. describeAccounts "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	0 or more usernames between 1 and 64 bytes each.

`"usernames"`

The "usernames" property is a list of strings between 1 and 64 bytes long that specifies which usernames to use to filter the results of the "describeAccounts" action. Each account that has a username matching one of the specified usernames will be returned.

  "params": {
    "usernames": [
      "admin"
    ]