User Login

POST

/

v2

/

api

/

login

cURL

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

import requests

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

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/login", 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
}

Body

application/json

password

string

required

Required for add, get_password, and change_password action.

username

string

required

User login name.

account_name

string

Account group name (default: admin).

action

string

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

api

boolean

Whether logging in via API or not.

host_name

string

The FQDN name or IP address.

IP address.

new_password

string

Required for change_password action.

no_fqdn_check

boolean

Suppressing FQDN name check.

rbac_groups

string

RBAC groups to add the users to.

token

string

Required for verify_token action.

user_email

string

User email address.

what

enum<string>

Which parameter to change.

Available options:

account_name,

email,

password

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 POST "https://<controller>/v2/api/login" \
  -H "Authorization: cid <CID>"

import requests

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

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

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/login", 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
}