EdgeCore version: 4.3.2
Method
POST /public/ldap/{ldapName}
Used to create an LDAP connection in EdgeCore.
Parameters
| Name | Type | Description | Mandatory |
ldapName |
string | Name of the shared configuration | Yes |
type |
string | Specific type of LDAP. Possible types: OpenLDAP: Assumes standard OpenLDAP defaults to simplify configuration.Active Directory: Assumes standard Active Directory defaults to simplify configuration.Generic LDAP: Can be used with almost any LDAP configurations. It exposes all supported options and allows for advanced configuration details to be provided. |
Yes |
host |
string | Host name of the LDAP server | Yes |
port |
integer | TCP port number of the LDAP server | No |
useSsl |
boolean | Specifies whether you want to use Secure Socket Layer | Yes |
useGroup |
boolean | Specifies whether you want to look up LDAP groups to be mapped to the roles in the system | Yes |
searchUser |
string | Distinguished name of the LDAP element containing the users to be found
Possible values: CN=Administrator,CN=Users,DC=aws,DC=edgeti,DC=com |
Yes |
searchPass |
string | Password of a user with permission to query the LDAP server
You can provide either a plain text password or an encrypted one. |
Yes |
groupSearchString |
string | Distinguished name of the LDAP element under which all groups may be found
Possible values: DC=aws,DC=edgeti,DC=com |
No |
groupSearchFilter |
string | Query that will be run to find one or more groups
Example: (&(objectCategory=group)(member=*)) |
No |
groupAttribute |
string | Group attribute that should be used to identify groups
Example: cn |
No |
cURL example
curl --location --request POST 'http://localhost:8080/public/ldap/EDGELDAP22' \ --header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5' \ --form 'type=Active Directory' \ --form 'host=dev-ad.edge.internal' \ --form 'port=389' \ --form 'useSsl=false' \ --form 'useGroup=false' \ --form 'searchUser=CN=Administrator,CN=Users,DC=aws,DC=edgeti,DC=com' \ --form 'searchPass=Xkkvq4?%K$' \ --form 'groupSearchString=DC=aws,DC=edgeti,DC=com' \ --form 'groupSearchFilter=(&(objectCategory=group)(member=*))' \ --form 'groupAttribute=cn'
Example Response
{
"doClass": "AccountAdapterConfigDO",
"id": "08a693-0h5otl4073rb",
"properties": {
"doClass": "PropertyBundleDO",
"propertyValues": [
{
"doClass": "PropertyValueDO",
"propertyDefName": "groupAttribute",
"propertyTypeName": "String",
"boundToParameter": false,
"value": "cn",
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "port",
"propertyTypeName": "Integer",
"boundToParameter": false,
"value": 389,
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "useGroup",
"propertyTypeName": "Boolean",
"boundToParameter": false,
"value": true,
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "credentials",
"propertyTypeName": "Credentials",
"boundToParameter": false,
"value": "{\"doClass\":\"CredentialSetDO\",\"isParameter\":false,\"credentials\":[{\"doClass\":\"CredentialPairDO\",\"key\":\"Username\",\"value\":{\"doClass\":\"SpStringValueDO\",\"isParameter\":false,\"primitiveValue\":\"CN=Administrator,CN=Users,DC=aws,DC=edgeti,DC=com\"},\"hidden\":false,\"required\":false},{\"doClass\":\"CredentialPairDO\",\"key\":\"Password\",\"value\":{\"doClass\":\"SpEncryptedStringValueDO\",\"isParameter\":false,\"plainValue\":\"UNUSED\",\"encryptedValue\":\"#default!63lABR0SLsjoekWFOAn7L8tBRXiCK3OWkg0/k3TqkeZc3Ew4I5FW0Ih9smeBSDw1\"},\"hidden\":true,\"required\":false}]}",
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "groupSearchFilter",
"propertyTypeName": "String",
"boundToParameter": false,
"value": "(&(objectCategory=group)(member=*))",
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "name",
"propertyTypeName": "String",
"boundToParameter": false,
"value": "EDGELDAP22",
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "host",
"propertyTypeName": "String",
"boundToParameter": false,
"value": "dev-ad.edge.internal",
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "type",
"propertyTypeName": "String",
"boundToParameter": false,
"value": "Active Directory",
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "useSsl",
"propertyTypeName": "Boolean",
"boundToParameter": false,
"value": false,
"metaJson": null
},
{
"doClass": "PropertyValueDO",
"propertyDefName": "groupSearchString",
"propertyTypeName": "String",
"boundToParameter": false,
"value": "DC=aws,DC=edgeti,DC=com",
"metaJson": null
}
]
},
"configTypeName": "LDAP-shared-Active Directory"
}
HTTP Response
| Code | Status | Description |
| 201 | Created | The request has succeeded and a new resource has been created as a result. |