25.4. Configuring Integration with a Directory Service #
In the
ppem-manager.ymlmanager configuration file, add theldapsection and specify integration parameters:OpenLDAP:
ldap: type:
directory_service_typeurl:directory_service_network_addressuse_ssl: trueorfalse base_dn:directory_service_base_DNbind_username:directory_service_usernamebind_password:directory_service_user_passwordgroup_class:user_group_object_classgroup_members_attr:user_group_member_attributegroup_name_attr:user_group_name_attributeprefix_group_dn:DN_prefix_for_user_groupsprefix_user_dn:DN_prefix_for_usersuser_class:user_object_classuser_display_name_attr:user_display_name_attributeuser_email_attr:user_email_attributeuser_name_attr:user_login_attributeuser_first_name_attr:user_first_name_attributeuser_last_name_attr:user_last_name_attributeuser_job_title_attr:user_job_title_attributeuser_membership_attr:user_group_membership_attributeuser_phone_attr:user_phone_attributeuser_sync_interval:manager_and_directory_service_synchronization_timeActive Directory:
ldap: type:
directory_service_typeurl:directory_service_network_addressbase_dn:directory_service_base_DNbind_username:directory_service_usernamebind_password:directory_service_user_passworduser_sync_interval:manager_and_directory_service_synchronization_time
Where:
type: The type of the directory service.Possible values:
openldapms_active_directory
url: The network address of the directory service.bind_username: The name of the directory service user for integration with PPEM.The value format depends on the directory service:
For OpenLDAP, a complete distinguished name (DN) is usually specified. For example,
cn=admin,ou=users,dc=example,dc=com.For Active Directory, a value in the
format is usually specified. For example,username@domainadmin@example.com.
bind_password: The password of the directory service user for integrating with PPEM.base_dn: The base distinguished name of the directory service.prefix_user_dn: The distinguished name prefix for users.If this parameter is specified, users are searched using the
distinguished name. To search for users in the entire directory, specifyprefix_user_dn,base_dn"".Optional parameter.
prefix_group_dn: The distinguished name prefix for user groups.If this parameter is specified, user groups are searched using the
distinguished name. To search for user groups in the entire directory, specifyprefix_group_dn,base_dn"".Optional parameter.
user_class: The name of the user object class.Optional parameter for Active Directory.
user_name_attr: The name of the user login attribute.Default value:
cnfor OpenLDAP,sAMAccountNamefor Active Directory.Optional parameter for Active Directory.
user_first_name_attr: The name of the user first name attribute.Default value:
givenName.Optional parameter.
user_last_name_attr: The name of the user last name attribute.Default value:
sn.Optional parameter.
user_display_name_attr: The name of the user display name attribute.Default value:
displayName.Optional parameter.
user_email_attr: The name of the user email address attribute.Default value:
mail.Optional parameter.
user_phone_attr: The name of the user phone number attribute.Default value:
telephoneNumber.Optional parameter.
user_job_title_attr: The name of the user job title attribute.Default value:
title.Optional parameter.
user_membership_attr: The name of the user group membership attribute.Default value for Active Directory:
memberOf.Optional parameter.
group_class: The name of the user group object class.Default value for Active Directory:
group.group_name_attr: The name of the user group name attribute.Default value:
cn.Optional parameter.
group_members_attr: The name of the group member attribute.group_filter: The filter for searching user groups. For example,(&(objectClass=group)(cn=*PPEM*)).Optional parameter.
group_membership_filter: The filter for searching groups of which the specified user is a member. For example,(&(objectClass=group)(uniqueMember=%USER_DN%)).Optional parameter.
group_list_size_limit: The maximum number of user groups that can be received from the directory service.Optional parameter.
user_sync_interval: Synchronization time between the manager and directory service.Default value:
5m.Optional parameter.
ssl_cert_skip_verify: Specifies whether verification of the directory service server certificate is skipped.Possible values:
truefalse
Optional parameter.
ssl_root_ca: The path to the file in the PEM format with the CA certificate on the directory service server.Optional parameter.
Restart the PPEM service:
systemctl restart ppem.service