EdgeCore version: 4.3.2
Method
POST /public/domains/{domainName}?useLdap=true
Used to add a domain with LDAP.
Parameters
| Name | Type | Description | Mandatory |
domainName |
string | Name of the domain | Yes |
useLdap |
boolean | Specifies whether LDAP is used | Yes |
ldapName |
string | Name of the LDAP connection | Yes |
loginAttribute |
string | Attribute of the user that will be used for login purposes | Yes |
userSearchString |
string | Distinguished name of the LDAP element containing the users to be found
Possible values: DC=aws,DC=edgeti,DC=com |
Yes |
userSearchFilter |
string | Search query that will be executed to search for one or more users | Yes |
userAttributesToCache |
string | Attributes that will be stored
Example: cn, email, address |
Yes |
cURL example
curl --location --request POST 'http://localhost:8080/public/domains/TESTDOMAIN?useLdap=true' \
--header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5' \
--form 'ldapName=EDGELDAP22' \
--form 'loginAttribute=sAMAccountName' \
--form 'userSearchString=DC=aws,DC=edgeti,DC=com' \
--form 'userSearchFilter=(&(objectCategory=person){USER_SEARCH_CLAUSE})' \
--form 'userAttributesToCache=cn,email,address'
Example Response
{
"doClass": "AccountDomainDO",
"id": "08a693-0h5otl4073s5",
"hidden": false,
"name": "TESTDOMAIN",
"userCount": -1,
"adapterName": "TESTDOMAIN",
"deletable": true,
"kioskMode": null,
"passwordPolicy": null,
"domainSuffix": "TESTDOMAIN",
"securityForms": [],
"disabledFormIds": [],
"sessionTimeout": {
"doClass": "SessionTimeoutDO",
"id": "08a693-0h5otl4073s6",
"inherited": true,
"value": 3600
}
}
HTTP Response
| Code | Status | Description |
| 201 | Created | The request has succeeded and a new resource has been created as a result. |