Import user from LDAP
curl --request POST \
--url http://10.2.4.166:8080/composer/api/security/ldap/users \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '[
"<string>"
]'import requests
url = "http://10.2.4.166:8080/composer/api/security/ldap/users"
payload = ["<string>"]
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(['<string>'])
};
fetch('http://10.2.4.166:8080/composer/api/security/ldap/users', 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/users",
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([
'<string>'
]),
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/users"
payload := strings.NewReader("[\n \"<string>\"\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/users")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("[\n \"<string>\"\n]")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/security/ldap/users")
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 \"<string>\"\n]"
response = http.request(request)
puts response.read_body{
"createdUsers": [
{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"deletable": true,
"availableAttributeKeys": [
"<string>"
],
"activeGroups": [
"<string>"
],
"activeRoles": [
"<string>"
],
"version": 123,
"userId": "<string>"
}
],
"skippedUsers": [
{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"deletable": true,
"availableAttributeKeys": [
"<string>"
],
"activeGroups": [
"<string>"
],
"activeRoles": [
"<string>"
],
"version": 123,
"userId": "<string>"
}
],
"warnings": [
"<string>"
]
}Import user from LDAP
Supervisor authority or role Administer Users is required to access this endpoint
Import user from LDAP
curl --request POST \
--url http://10.2.4.166:8080/composer/api/security/ldap/users \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '[
"<string>"
]'import requests
url = "http://10.2.4.166:8080/composer/api/security/ldap/users"
payload = ["<string>"]
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(['<string>'])
};
fetch('http://10.2.4.166:8080/composer/api/security/ldap/users', 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/users",
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([
'<string>'
]),
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/users"
payload := strings.NewReader("[\n \"<string>\"\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/users")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("[\n \"<string>\"\n]")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/security/ldap/users")
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 \"<string>\"\n]"
response = http.request(request)
puts response.read_body{
"createdUsers": [
{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"deletable": true,
"availableAttributeKeys": [
"<string>"
],
"activeGroups": [
"<string>"
],
"activeRoles": [
"<string>"
],
"version": 123,
"userId": "<string>"
}
],
"skippedUsers": [
{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"deletable": true,
"availableAttributeKeys": [
"<string>"
],
"activeGroups": [
"<string>"
],
"activeRoles": [
"<string>"
],
"version": 123,
"userId": "<string>"
}
],
"warnings": [
"<string>"
]
}Authorizations
HTTP Basic authentication using global administrator credentials (username and password).
Body
application/vnd.composer.v3+json
Was this page helpful?