OpenLDAP LDAP integration reference
This topic provides reference information specific to OpenLDAP Lightweight Directory Access Protocol (LDAPLightweight Directory Access Protocol (LDAP) is a lightweight client-server protocol for accessing directory services, specifically X.500-based directory services. LDAP runs over TCP/IP or other connection oriented transfer services.) integrations. When you're installing the Okta LDAP agentA software agent is a lightweight program that runs as a service outside of Okta. It is typically installed behind a firewall and allows Okta to tunnel communication between an on-premises service and Okta's cloud service. Okta employs several agent types: Active Directory, LDAP, RADIUS, RSA, Active Directory Password Sync, and IWA. For example, users can install multiple Active Directory agents to ensure that the integration is robust and highly available across geographic locations., you'll need this information to integrate your OpenLDAP directory with Okta. See Install and configure the Okta LDAP agent.
During the initial agent install and configuration documented in Install and configure the Okta LDAP agent, these are the attributes for OpenLDAP integrations:
- Unique Identifier Attribute - entryuuid
- DN Attribute - entrydn
- User Object Class - inetorgperson
- User Object Filter - (objectclass=inetorgperson)
- *Account Disabled Attribute - pwdlockout
- *Account Disabled Value - TRUE
- *Account Enabled Value - FALSE
- Password Attribute - userpassword
- Group Object Class - groupofuniquenames
- Group Object Filter - (objectclass=groupofuniquenames)
- Member Attribute - uniquemember
There are no special considerations for OpenLDAP integrations.
To add attributes from AUX classes, add the auxiliary class as an Auxiliary Object Class to the directory provisioning configuration.
Users trigger a password change by selecting Settings on the Okta end user dashboard.
To allow users to change or reset their password, click Security > Delegated AuthenticationAuthentication is distinct from authorization, which is the process of giving individuals access to system objects based on their identity. Authentication merely ensures that the individual is who he or she claims to be, but says nothing about the access rights of the individual. Authentication methods and protocols include direct auth, delegated auth, SAML, SWA, WS-Fed, and OpenID Connect. , select the LDAP tab, and then select Users can change their LDAP passwords in Okta.
Password reset is triggered by an administrator or the User Forgot Password flow.
Password reset can fail if the new password does not meet the password policy criteria.
Use the pwdPolicy object class and pwdPolicySubentry attribute to implement OpenLDAP specific password policies.
There are no special considerations for OpenLDAP LDAP integrations.
There are no special considerations for OpenLDAP Just In Time (JIT) provisioning. For user identification (UID), use an email format to match the default setting for an Okta username. Do not use an external identity provider (IDPAn acronym for Identity Provider. It is a service that manages end user accounts analogous to user directories such as LDAP and Active Directory, and can send SAML responses to SPs to authenticate end users. Within this scenario, the IdP is Okta.) to trigger sign in.
To make sure that JIT provisioning is successful the first time:
- the value of the configured naming attribute (such as UID) must not exist in Okta.
- the value of the configured naming attribute (such as UID) must be unique in all JIT-enabled directories.
- the required attributes must present. The Okta defaults are email, givenName, sn, and uid.
- the password must be correct.
- the Account Disabled Attribute must be set to false on the LDAP server.
When JIT provisioning completes successfully, all of the user attributes specified on the LDAP settings page and in the Profile Editor are imported. To select additional mandatory attributes, use the Profile Editor.
User profiles with OpenLDAP settings are added to groupsGroups allow you to organize your end users and the apps they can access. Assigning apps to large sets of end users is made easier with groups. with the object class
groupofuniquenames and assigned the
uniquemember group attribute.
During import, if the membership attribute is set to seeAlso, users are assigned to the groups added to the seeAlso user attribute.
The create user functionality is not available with OpenLDAP server.
To allow passwords to be set when users are created or assigned, disable DelAuth, enable LDAP_PUSH_PASSWORD_UPDATES, and enable password sync on your LDAP instance. With these settings, the LDAP agent sends the PASSWORD_UPDATE action when the user logs in for the first time or when they are assigned. If you do not set these settings, the password is not transferred to your LDAP instance.
To create and assign passwords when creating user profiles:
- Contact Okta customer support to enable LDAP push password updates.
- Disable delegated authentication:
- Click Security > Delegated Authentication > LDAP.
- Click Edit in the Delegated Authentication pane.
- Clear the Enable delegated authentication to LDAP check box.
- Click Save.
- Accept the default setting to reset all LDAP user passwords and click Disable LDAP Authentication.
- Open your Okta AdminAn abbreviation of administrator. This is the individual(s) who have access to the Okta Administrator Dashboard. They control the provisioning and deprovisioning of end users, the assigning of apps, the resetting of passwords, and the overall end user experience. Only administrators have the Administration button on the upper right side of the My Applications page. Console, click Directory > Directory Integrations > LDAP > ProvisioningProvisioning is the enterprise-wide configuration, deployment, and management of multiple types of IT system resources. Specifically, provisioning provides users access to equipment, software, or services. This involves creating, maintaining and deactivating required business process automation objects and attributes in systems, directories, and applications. > To AppAn abbreviation of application. Essentially, it is a web-based site used to perform any number of specific tasks, and requires authentication from end users by signing in..
- Click Edit, select Enable next to Sync Password, and click Save.
When Sync Password is enabled, the LDAP agent sends the action PASSWORD_UPDATE when the user signs in for the first time.
To assign existing Okta users to LDAP:
- Open your Okta Admin Console, click Directory > Directory Integrations > LDAP > Provisioning > To App.
- Click Edit, select Enable next to Create Users, and click Save.
- Click Directory > Groups.
- Select the Okta group to which you want to assign users.
- Click Manage Directories.
- Select an LDAP instance in the left pane and click Next.
- Enter the full distinguished name (DN) for the new user LDAP container in the Provisioning Destination DN field.
- Click Confirm Changes.
If LDAP directory authentication fails, the agent logs display messages similar to the following to assist with diagnosis and resolution:
scanResults are sent with user+group info
POST initiated with result status=SUCCESS, actionType=USER_AUTH_AND_UPDATE, actionId=ADStflgt5KS4Gy17k0g3, diagnostic message=, error code=, matched dn=, message=SUCCESS, result code=, vendor=OPEN_LDAP
Agent: Delauth failure
POST initiated with result status=FAILURE, actionType=USER_AUTH_AND_UPDATE, actionId=ADStftCWoSunnemFU0g3, diagnostic message=, error code=49, matched dn=cn=PasswordPolicyUser,ouAn acronym of Organizational Unit. Organizational units are Active Directory containers into which you can place users, groups, computers, and other organizational units. It is the smallest scope or unit to which you can assign Group Policy settings or delegate administrative authority.=LynxyUsers,dc=okta-openldap,dc=com, message=LDAPException(resultCode=49 (invalid credentials), errorMessage='invalid credentials'), result code=invalid credentials, vendor=OPEN_LDAP
Agent: No user
POST initiated with result status=FAILURE, actionType=USER_AUTH_AND_UPDATE, actionId=ADStfjpuawUSY1Gge0g3, diagnostic message=, error code=, matched dn=, message=User not found while executing query: (&(objectclass=inetorgperson)(uid=PasswordPolicyer@openldap.com)), result code=, vendor=OPEN_LDAP
Agent: Password Expired
POST initiated with result status=FAILURE, actionType=USER_AUTH_AND_UPDATE, actionId=ADStfhvei0D6IaFJO0g3, diagnostic message=, error code=49, matched dn=cn=PasswordPolicyUser,ou=LynxyUsers,dc=okta-openldap,dc=com, message=LDAPException(resultCode=49 (invalid credentials), errorMessage='invalid credentials'), result code=invalid credentials, vendor=OPEN_LDAP
Agent: Locked Out/Disabled
pwdLockout set as TRUE for user pwdPolicy
POST initiated with result status=FAILURE, actionType=USER_AUTH_AND_UPDATE, actionId=ADSticrFpY0IyooMU0g3, diagnostic message=, error code=49, matched dn=cn=PasswordPolicyUser,ou=LynxyUsers,dc=okta-openldap,dc=com, message=LDAPException(resultCode=49 (invalid credentials), errorMessage='invalid credentials'), result code=invalid credentials, vendor=OPEN_LDAPTop