Test LDAP configuration

POST

/

v2

/

api

/

test_ldap_configuration

cURL

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

import requests

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

base_dn

string

required

User entries: Base DN.

bind_dn

string

required

Bind DN.

ldap_server

string

required

LDAP server IP address.

password

string

required

Bind DN password.

port

string

required

LDAP TCP port.

username_attribute

string

required

Username attribute.

CID

string

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

action

string

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

ca_cert

string

CA cert (inline PEM or controller upload path). This field must be base64 encoded.

client_cert

string

Client cert bundle (inline PEM or controller upload path). This field must be base64 encoded.

get_config

boolean

Query LDAP login authentication config.

is_ldap_auth

enum<string>

Enable|Disable LDAP login authentication.

Available options:

false,

true

ldap_additional_req

string

Additional requirements.

ldap_use_ssl

enum<string>

Enable TLS authentication.

Available options:

false,

true

ldap_user

string

LDAP user.

save

boolean

Save LDAP parameter.

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

import requests

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