Test LDAP connection
curl --request POST \
--url http://10.2.4.166:8080/composer/api/security/ldap/test-connection \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"url": "<string>",
"userNameAttribute": "<string>",
"base": "<string>",
"query": "<string>",
"bind": "<string>",
"password": "<string>",
"fullNameAttribute": "<string>",
"enabled": true,
"enabledAutoProvisioning": true,
"autoCreateGroups": true,
"groupAttribute": "<string>",
"emailAttribute": "<string>",
"defaultAccountId": "<string>",
"accountAttribute": "<string>",
"activeAccountAttribute": "<string>",
"attributeMapping": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
]
}
'import requests
url = "http://10.2.4.166:8080/composer/api/security/ldap/test-connection"
payload = {
"url": "<string>",
"userNameAttribute": "<string>",
"base": "<string>",
"query": "<string>",
"bind": "<string>",
"password": "<string>",
"fullNameAttribute": "<string>",
"enabled": True,
"enabledAutoProvisioning": True,
"autoCreateGroups": True,
"groupAttribute": "<string>",
"emailAttribute": "<string>",
"defaultAccountId": "<string>",
"accountAttribute": "<string>",
"activeAccountAttribute": "<string>",
"attributeMapping": [
{
"key": "<string>",
"value": "<string>",
"encrypted": True
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
url: '<string>',
userNameAttribute: '<string>',
base: '<string>',
query: '<string>',
bind: '<string>',
password: '<string>',
fullNameAttribute: '<string>',
enabled: true,
enabledAutoProvisioning: true,
autoCreateGroups: true,
groupAttribute: '<string>',
emailAttribute: '<string>',
defaultAccountId: '<string>',
accountAttribute: '<string>',
activeAccountAttribute: '<string>',
attributeMapping: [{key: '<string>', value: '<string>', encrypted: true}]
})
};
fetch('http://10.2.4.166:8080/composer/api/security/ldap/test-connection', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/security/ldap/test-connection",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'userNameAttribute' => '<string>',
'base' => '<string>',
'query' => '<string>',
'bind' => '<string>',
'password' => '<string>',
'fullNameAttribute' => '<string>',
'enabled' => true,
'enabledAutoProvisioning' => true,
'autoCreateGroups' => true,
'groupAttribute' => '<string>',
'emailAttribute' => '<string>',
'defaultAccountId' => '<string>',
'accountAttribute' => '<string>',
'activeAccountAttribute' => '<string>',
'attributeMapping' => [
[
'key' => '<string>',
'value' => '<string>',
'encrypted' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://10.2.4.166:8080/composer/api/security/ldap/test-connection"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"userNameAttribute\": \"<string>\",\n \"base\": \"<string>\",\n \"query\": \"<string>\",\n \"bind\": \"<string>\",\n \"password\": \"<string>\",\n \"fullNameAttribute\": \"<string>\",\n \"enabled\": true,\n \"enabledAutoProvisioning\": true,\n \"autoCreateGroups\": true,\n \"groupAttribute\": \"<string>\",\n \"emailAttribute\": \"<string>\",\n \"defaultAccountId\": \"<string>\",\n \"accountAttribute\": \"<string>\",\n \"activeAccountAttribute\": \"<string>\",\n \"attributeMapping\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/security/ldap/test-connection")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"url\": \"<string>\",\n \"userNameAttribute\": \"<string>\",\n \"base\": \"<string>\",\n \"query\": \"<string>\",\n \"bind\": \"<string>\",\n \"password\": \"<string>\",\n \"fullNameAttribute\": \"<string>\",\n \"enabled\": true,\n \"enabledAutoProvisioning\": true,\n \"autoCreateGroups\": true,\n \"groupAttribute\": \"<string>\",\n \"emailAttribute\": \"<string>\",\n \"defaultAccountId\": \"<string>\",\n \"accountAttribute\": \"<string>\",\n \"activeAccountAttribute\": \"<string>\",\n \"attributeMapping\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/security/ldap/test-connection")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"url\": \"<string>\",\n \"userNameAttribute\": \"<string>\",\n \"base\": \"<string>\",\n \"query\": \"<string>\",\n \"bind\": \"<string>\",\n \"password\": \"<string>\",\n \"fullNameAttribute\": \"<string>\",\n \"enabled\": true,\n \"enabledAutoProvisioning\": true,\n \"autoCreateGroups\": true,\n \"groupAttribute\": \"<string>\",\n \"emailAttribute\": \"<string>\",\n \"defaultAccountId\": \"<string>\",\n \"accountAttribute\": \"<string>\",\n \"activeAccountAttribute\": \"<string>\",\n \"attributeMapping\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyTest LDAP connection
Supervisor authority is required to access this endpoint
Test LDAP connection
curl --request POST \
--url http://10.2.4.166:8080/composer/api/security/ldap/test-connection \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"url": "<string>",
"userNameAttribute": "<string>",
"base": "<string>",
"query": "<string>",
"bind": "<string>",
"password": "<string>",
"fullNameAttribute": "<string>",
"enabled": true,
"enabledAutoProvisioning": true,
"autoCreateGroups": true,
"groupAttribute": "<string>",
"emailAttribute": "<string>",
"defaultAccountId": "<string>",
"accountAttribute": "<string>",
"activeAccountAttribute": "<string>",
"attributeMapping": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
]
}
'import requests
url = "http://10.2.4.166:8080/composer/api/security/ldap/test-connection"
payload = {
"url": "<string>",
"userNameAttribute": "<string>",
"base": "<string>",
"query": "<string>",
"bind": "<string>",
"password": "<string>",
"fullNameAttribute": "<string>",
"enabled": True,
"enabledAutoProvisioning": True,
"autoCreateGroups": True,
"groupAttribute": "<string>",
"emailAttribute": "<string>",
"defaultAccountId": "<string>",
"accountAttribute": "<string>",
"activeAccountAttribute": "<string>",
"attributeMapping": [
{
"key": "<string>",
"value": "<string>",
"encrypted": True
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
url: '<string>',
userNameAttribute: '<string>',
base: '<string>',
query: '<string>',
bind: '<string>',
password: '<string>',
fullNameAttribute: '<string>',
enabled: true,
enabledAutoProvisioning: true,
autoCreateGroups: true,
groupAttribute: '<string>',
emailAttribute: '<string>',
defaultAccountId: '<string>',
accountAttribute: '<string>',
activeAccountAttribute: '<string>',
attributeMapping: [{key: '<string>', value: '<string>', encrypted: true}]
})
};
fetch('http://10.2.4.166:8080/composer/api/security/ldap/test-connection', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/security/ldap/test-connection",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'userNameAttribute' => '<string>',
'base' => '<string>',
'query' => '<string>',
'bind' => '<string>',
'password' => '<string>',
'fullNameAttribute' => '<string>',
'enabled' => true,
'enabledAutoProvisioning' => true,
'autoCreateGroups' => true,
'groupAttribute' => '<string>',
'emailAttribute' => '<string>',
'defaultAccountId' => '<string>',
'accountAttribute' => '<string>',
'activeAccountAttribute' => '<string>',
'attributeMapping' => [
[
'key' => '<string>',
'value' => '<string>',
'encrypted' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://10.2.4.166:8080/composer/api/security/ldap/test-connection"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"userNameAttribute\": \"<string>\",\n \"base\": \"<string>\",\n \"query\": \"<string>\",\n \"bind\": \"<string>\",\n \"password\": \"<string>\",\n \"fullNameAttribute\": \"<string>\",\n \"enabled\": true,\n \"enabledAutoProvisioning\": true,\n \"autoCreateGroups\": true,\n \"groupAttribute\": \"<string>\",\n \"emailAttribute\": \"<string>\",\n \"defaultAccountId\": \"<string>\",\n \"accountAttribute\": \"<string>\",\n \"activeAccountAttribute\": \"<string>\",\n \"attributeMapping\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/security/ldap/test-connection")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"url\": \"<string>\",\n \"userNameAttribute\": \"<string>\",\n \"base\": \"<string>\",\n \"query\": \"<string>\",\n \"bind\": \"<string>\",\n \"password\": \"<string>\",\n \"fullNameAttribute\": \"<string>\",\n \"enabled\": true,\n \"enabledAutoProvisioning\": true,\n \"autoCreateGroups\": true,\n \"groupAttribute\": \"<string>\",\n \"emailAttribute\": \"<string>\",\n \"defaultAccountId\": \"<string>\",\n \"accountAttribute\": \"<string>\",\n \"activeAccountAttribute\": \"<string>\",\n \"attributeMapping\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/security/ldap/test-connection")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"url\": \"<string>\",\n \"userNameAttribute\": \"<string>\",\n \"base\": \"<string>\",\n \"query\": \"<string>\",\n \"bind\": \"<string>\",\n \"password\": \"<string>\",\n \"fullNameAttribute\": \"<string>\",\n \"enabled\": true,\n \"enabledAutoProvisioning\": true,\n \"autoCreateGroups\": true,\n \"groupAttribute\": \"<string>\",\n \"emailAttribute\": \"<string>\",\n \"defaultAccountId\": \"<string>\",\n \"accountAttribute\": \"<string>\",\n \"activeAccountAttribute\": \"<string>\",\n \"attributeMapping\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
HTTP Basic authentication using global administrator credentials (username and password).
Body
application/vnd.composer.v3+json
LDAP configuration object
Show child attributes
Show child attributes
Response
204
No Content
Was this page helpful?