Account Users

GET

/

v2

/

api

/

list_account_users

cURL

curl -sk -X GET "https://<controller>/v2/api/list_account_users" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/list_account_users"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/list_account_users", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Query Parameters

what

enum<string>

Which parameter to change.

Available options:

account_name,

email,

password

user_name

string

User login name.

account_name

string

Account group name (default: admin).

password

string

Required for add, get_password, and change_password action.

new_password

string

Required for change_password action.

user_email

string

User email address.

token

string

Required for verify_token action.

host_name

string

The FQDN name or IP address.

no_fqdn_check

boolean

Suppressing FQDN name check.

rbac_groups

string

RBAC groups to add the users to.

IP address.

api

boolean

Whether logging in via API or not.

action

string

The API action to perform. Required for 7.2 controllers only.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X GET "https://<controller>/v2/api/list_account_users" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/list_account_users"
headers = {"Authorization": "cid <CID>"}

response = requests.get(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://<controller>/v2/api/list_account_users", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}