Configure LDAP integration settings
After installing the Okta LDAP Agent, you'll need to configure the integration settings to allow data to be exchanged with Okta.
- In the Admin Console, go to Directory > Directory Integrations.
- Click the Okta LDAP Agent marked Not yet configured.
- Configure the following settings:
- LDAP Version — Select an LDAP provider. See Supported LDAP directories.
When you select an LDAP provider, provider-specific configuration values are automatically added. If your LDAP provider is not on the list, complete the configuration fields manually. Confirm the default values are correct. Not all configuration settings must have values.
- Unique Identifier Attribute — An auto-populated value defined by the selected LDAP provider. This value defines the unique immutable attribute of all imported LDAP objects (users and groups). Only objects possessing this attribute can be imported into your Okta org. You can change the auto-populated value during initial setup. Note: if your LDAP server implements RFC 4530, make sure to enter entryuuid in this field. For AD LDS, use objectguid.
- DN Attribute — An auto-populated value defined by the selected LDAP provider. The attribute on all LDAP objects containing the Distinguished Name value.
- In the User section, configure the following settings:
- User Search Base — Enter the Distinguished Name (DN) of the container for user searches (that is, root of the user subtree). This is the base DN of the container that holds all users imported into your Okta org. For example: cn=Users, dc=example, dc=com.
- User Object Class — The objectClass of a user that Okta uses in its query when importing users. For example, inetorgperson, posixaccount, posixuser.
- Auxiliary Object Class — Optional. Enter a comma-separated list of auxiliary objectClasses to use in Okta import queries. For example, auxClass1,auxClass2.
- User Object Filter — An auto-populated value defined by the selected LDAP provider. The default is objectClass (objectClass=<entered objectClass name>). This must be a valid LDAP filter.
Use standard LDAP search filter notation (RFC 2254). For example:
The same filter capability is also in place for Group Objects.
- Account Disabled Attribute — Enter the attribute that indicates whether or not the user account is disabled in Okta. If this attribute equals the value specified in the Account Disabled Value field, the user account is deactivated.
- Account Disabled Value — Enter the value that indicates that the account is locked (for example, TRUE).
- Password Attribute — Enter the user password attribute.
- Password Expiration Attribute — An auto-populated value when a supported LDAP provider is selected. If your directory provider is not in the list, see your LDAP server documentation or configuration for the password expiry value. Often, this attribute is a Boolean value.
- Extra User Attributes — Optional. Enter additional user attributes to import from LDAP.
- Complete the Group or Role section. Typically, only one of these is used.Group
- Group Search Base — Enter the DN of the container for group searches (that is, root of the group subtree) that holds all groups that will be imported into your Okta org. For example: ou=groups, dc=example, dc=com.
- Group Object Class — Enter the objectClass of the group that Okta uses in its query when importing groups. For example, groupofnames, groupofuniquenames, posixgroup.
- Group Object Filter – An auto-populated value when a supported LDAP provider is selected. (objectClass=<entered objectClass name>).
- Member Attribute — The attribute containing all the member DNs.
- User Attribute — Okta uses the member attribute on the group object to determine the user group memberships at runtime. Unless your group object and group filter is explicitly posixGroup and (objectclass=posixGroup), leave the user attribute field empty. If you are using posixGroup, we recommend that you configure the member attribute value to memberUID and the user attribute value to uid.
If the specified group object and group filter is posixGroup . . . ,
then enter memberUid in the User Attribute field.
If the specified group object and group filter is something other than posixGroup . . . ,
then leave the User Attribute field blank.
- Object Class – The objectClass of a role.
- Membership Attribute – The attribute of the user object that indicates role membership (that is, containing the role DNs).
- Configure the following settings in the Validation configuration section:
Choose from schema
- Example username.
When you import users from LDAP, these settings are used to generate the Okta username that your users use to sign in to Okta.
Note: Okta requires that valid user names are in an email format. Configuring these options correctly makes sure that your user names satisfy this requirement.Email address
Select this option if you want your users' LDAP email address to be their Okta username. Note: Email addresses must be unique in LDAP.
If email addresses in LDAP are email@example.com . . . ,
and you select the Email address Okta username format . . . ,
enter firstname.lastname@example.org in the Username field.Employee Number (employeeNumber)
Select this option to use a user's employee number as the Okta username.Common Name (CN)
Select this option to use a user's common name as the Okta username.User Id(UID)
Select this option only if the UID value in the LDAP directory is already formatted as an email address.
If the UID in LDAP is already formatted as an email address like email@example.com . . . ,
and you select the User Id (UID) Okta username format . . . ,
enter firstname.lastname@example.org in the Username field.User Id (UID) + Configurable Suffix
Select this option only if the UID value in LDAP lacks an email suffix and you want end users to sign in using a configurable email suffix.
If the UID in LDAP is user.1234 . . . ,
and you select the User Id (UID) + Configurable Suffix Okta username format . . . ,
enter yourconfigurablesuffix.com in the Configurable Suffix field . . .
enter email@example.com in the Username field.User Id (UID) @ Domain
Select this option only if the UID value in LDAP lacks an email suffix and you want Okta user names to include your company's domain name as the email suffix.
If the UID in LDAP is user.1234 . . . ,
and your company's domain name is yourdomainname . . . ,
and you select the User Id (UID) @ Domain Okta username format . . . ,
enter firstname.lastname@example.org in the Username field.
Select this option to use a single-value, LDAP string attribute as the Okta username. A list of available attributes appears when you select this option.
- Enter a Username.
Enter the username of a user in the specified username format. Since the username that you enter uniquely identifies a single user in your LDAP directory, the query that Okta executes will retrieve only your specified user and the following details about the user. Validate that all returned details are correct.
- Unique ID
- Distinguished Name
- Full Name
- Groups – All the groups of the specified Group Object Class within the Group Search Base of which this user is a member. If the expected groups are not listed here, group imports might fail later.
- Example username.
- When your settings are successfully validated, click Next and then Done to complete LDAP configuration.
After validating your settings, Okta begins the LDAP schema discovery process.