Versions Compared

Old Version 1

changes.mady.by.user Sara Paulina Moraga Alfaro

Saved on

compared with

New Version 2

changes.mady.by.user Sara Paulina Moraga Alfaro

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Credentials configuration guidelines can be found here.

Ldap Identity Connector's Credentials type must always be specified as "ldap-identity".

Properties specific to the Ldap Identity Connector's Credentials are described below.

Easy Heading Free
navigationTitleOn this Page
wrapNavigationTexttrue
navigationExpandOptionexpand-all-by-default

Ldap Identity Connection Properties

Field

Required

Default

Multiple

NotesExample
typeYes-No

The value must be "".

"ldap-identity"

descriptionYes-NoName of the
credential
connection object.

"

Ldap IdentityCredential

MyLdap ServerConnection"

properties
credentialYes-No
Configuration objecttenantDomain
ID of the credential."f5587cee-9116-4011-b3a9-6b235b333a1b"
propertiesYes-No
The Azure tenant domain to be used."myTenantDomain.onmicrosoft.com"useProxy
Configuration object
useScriptNofalseNo
Enables the use of a proxy to get access to Azure endpoints.true
Select to either connect to an LDAP or Active Directory (AD) server to download user and group information, or to run a script to fetch the information that should be cached.false
serverYes
proxyHostNo
-NoThe
address of the proxy to be used."http://myproxy.mycompany.com"proxyPortNo-NoThe port of the proxy to be used.9027socketTimeoutNo"60000ms"NoSocket timeout value."120s"connectTimeoutNo"60000ms"NoConnection timeout value"120s"connectionRequestTimeoutNo"60000ms"NoConnection request timeout value"120s"maxConnectionsNo150NoMaximum number of connection to the different Azure endpoints used.200maxConnectionsPerRouteNo15NoMaximum number of connection to a specific Azure endpoint.20No
url of the LDAP server in the form ldap:server:port. For Active Directory (AD) servers, the LDAP protocol should be in upper case LDAP:server:port

"ldap://server:port"

searchBaseYes

"GlobalCatalog"

NoThe node in the directory from which to begin searches.
"dc=com,dc=accenture"

scope

No

SUBTREE

Yes

The scope of the LDAP search.

OBJECT, ONE_LEVEL, SUBTREE

userQuery

Yes

(&(objectClass=User)(objectCategory=Person))

No

The ldap query to return all users.

"(&(objectClass=User)(objectCategory=Person))"

groupQuery

Yes"(objectCategory=Group)"No

The ldap query to return all groups.

"(objectCategory=Group)"

connectTimeout

Yes"15s"NoThe maximum time to wait for a connection to the ldap server."15s"

readTimeout

Yes"15s"No

The maximum time to wait for data from the LDAP server.

"15s"

useTLS

NofalseNo

If checked, the Start TLS extension will be used to connect to the LDAP server.

false

outputFormat

NoJSONYes

Format of the output of the script.

XML, JSON

Example

Code Block
themeRDark
titlePOST /aspire/_api/connections
{
    "credential":"aa1bc268f5587cee-8b549116-4ea34011-b43db3a9-a15b665d04de6b235b333a1b",
    "type": "ldap-identity",
    "description": "Ldap Identity Connection Test",
    "properties": {
		"tenantDomainuseScript":"myTenantDomain.onmicrosoft.comfalse",
        "useProxyserver": "falseldap://server:port",
        "socketTimeoutsearchBase" : "60sdc=com,dc=accenture",
        "connectTimeoutscope" : "60sSUBTREE",
        "connectionRequestTimeoutuserQuery" : "60s(&(objectClass=User)(objectCategory=Person))",
        "maxConnectionsgroupQuery" : "100(objectCategory=Group)",
        "maxConnectionsPerRoute"connectTimeout" : "15s",
		"readTimeout" : "1015s",
        "useTLS" : "false"
 }
}