Test LDAP bind

POST

/

v2

/

api

/

test_ldap_bind

cURL

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

import requests

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

ldap_base_dn

string

required

Base DN for User entries.

ldap_bind_dn

string

required

Bind DN.

ldap_password

string

required

Bind DN password.

ldap_server

string

required

LDAP server address.

ldap_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.

dns

boolean

Modifying a DNS.

enable_ldap

boolean

Enable LDAP authentication.

lb_name

string

Load balancer name.

ldap_additional_req

string

Additional requirements.

ldap_ca_cert

string

CA cert in PEM format. This field must be base64 encoded.

ldap_client_cert

string

Client cert in PEM format. This field must be base64 encoded.

ldap_enable_tls

enum<string>

Enable TLS authentication.

Available options:

yes,

no

ldap_user

string

LDAP user.

vpc_id

string

VPC_ID.

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

import requests

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