LDAP login status

GET

/

v2

/

api

/

get_ldap_login_status

cURL

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

import requests

url = "https://<controller>/v2/api/get_ldap_login_status"
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/get_ldap_login_status", 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

ldap_ip

string

LDAP server IP address.

ldap_ip_port

string

LDAP TCP port.

ldap_base_dn

string

User entries: Base DN.

ldap_user_attr

string

Username attribute.

ldap_additional_req

string

Additional requirements.

ldap_enable_tls

enum<string>

Enable TLS authentication.

Available options:

false,

true

ldap_bind_dn

string

Bind DN.

ldap_password

string

Bind DN password.

ldap_client_cert

string

Client cert bundle (inline PEM or controller upload path).

ldap_ca_cert

string

CA cert (inline PEM or controller upload path).

ldap_user

string

LDAP user.

is_ldap_auth

enum<string>

Enable|Disable LDAP login authentication.

Available options:

false,

true

save

boolean

Save LDAP parameter.

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/get_ldap_login_status" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/get_ldap_login_status"
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/get_ldap_login_status", 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
}