LdapDefinedSettings

LdapDefinedSettings
LdapDefinedSettings

LDAP settings when using a defined LDAP settings source.

JSON Example undefined undefined 
{
    "hostName": "string",
    "port": 0,
    "ssl": false,
    "pagedSearchDisabled": false,
    "pageSize": 0,
    "maxResults": 0,
    "maxUserGroups": 0,
    "searchBase": "string",
    "userName": "string",
    "password": "string",
    "groupSearchBase": "string",
    "customUiButtonLabel": "string",
    "userAttributes": {
        "objectClass": "string",
        "objectIdentifier": "string",
        "userName": "string",
        "email": "string",
        "displayName": "string",
        "givenName": "string",
        "surname": "string",
        "telephone": "string",
        "groupMembershipIdentifier": "string",
        "groupBackLinkIdentifier": "string",
        "domain": "string",
        "managerIdentifier": "string"
    },
    "groupAttributes": {
        "objectClass": "string",
        "objectIdentifier": "string",
        "groupName": "string",
        "membership": "string",
        "membershipIdentifier": "string",
        "backLinkIdentifier": "string"
    }
}
string
hostName
Required

LDAP server hostname.

integer
port
Required
Constraints: minimum: 1 maximum: 65335

LDAP server port.

boolean
ssl
Optional

Whether to use TLS/SSL connectivity to the LDAP server (i.e. LDAPS).

boolean
pagedSearchDisabled
Optional

Whether to disable paged searching.

integer
pageSize
Optional
Constraints: minimum: 1

Default page size for LDAP searches.

integer
maxResults
Optional
Constraints: minimum: 1

Default maximum result count for LDAP searches.

integer
maxUserGroups
Optional
Constraints: minimum: 1

Default maximum user group count.

string
searchBase
Required

The LDAP search base for users.

string
userName
Required

The LDAP server username.

string
password
Optional

The LDAP server password. Omit to leave unchanged.

string
groupSearchBase
Optional

The LDAP group search base.

string
customUiButtonLabel
Optional

Custom label for the login button when using LDAP login.

LdapUserAttributes
userAttributes
Required

The LDAP attributes used for required and optional user information.

LdapGroupAttributes
groupAttributes
Required

The LDAP attributes used for required and optional group information.

Property Of