Page History
LDAP Identity Connection Properties
Field | Required | Default | Multiple | Notes | Example |
|---|---|---|---|---|---|
| type | Yes | - | No | The value must be "". | "ldap-identity" |
| description | Yes | - | No | Name of the connection object. | "MyLdap ServerConnection" |
| credential | Yes | - | No | ID of the credential. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
| properties | Yes | - | No | Configuration object | |
| useScript | No | false | No | 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 |
| server | Yes | - | No | The 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" |
| searchBase | Yes | "GlobalCatalog" | No | The 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" | No | The 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 | No | false | No | If checked, the Start TLS extension will be used to connect to the LDAP server. | false |
outputFormat | No | JSON | Yes | Format of the output of the script. | XML, JSON |
Example
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"credential": "f5587cee-9116-4011-b3a9-6b235b333a1b",
"type": "ldap-identity",
"description": "Ldap Identity Connection Test",
"properties": {
"useScript": "false",
"server": "ldap://server:port",
"searchBase": "dc=com,dc=accenture",
"scope": "SUBTREE",
"userQuery": "(&(objectClass=User)(objectCategory=Person))",
"groupQuery": "(objectCategory=Group)",
"connectTimeout": "15s",
"readTimeout": "15s",
"useTLS": "false"
}
} |
Overview
Content Tools