diff --git a/docs/manage_role_by_ldap_group.md b/docs/manage_role_by_ldap_group.md index dc8d19d6f..4d85fe4c7 100644 --- a/docs/manage_role_by_ldap_group.md +++ b/docs/manage_role_by_ldap_group.md @@ -17,18 +17,23 @@ This guide provides instructions to manage roles by LDAP/AD group. You can impor Besides **[basic LDAP configure parameters](https://github.com/vmware/harbor/blob/master/docs/installation_guide.md#optional-parameters)** , LDAP group related configure parameters should be configured, they can be configured before or after installation - 1. Configure parameters in harbor.cfg before installation + 1. Configure LDAP parameters via API, refer to **[Config Harbor user settings by command line](configure_user_settings.md)** +For example: +``` +curl -X PUT -u ":" -H "Content-Type: application/json" -ki https://harbor.sample.domain/api/configurations -d'{"ldap_group_basedn":"ou=groups,dc=example,dc=com"}' +``` +The following parameters are related to LDAP group configuration. * ldap_group_basedn -- The base DN from which to lookup a group in LDAP/AD, for example: ou=groups,dc=example,dc=com * ldap_group_filter -- The filter to search LDAP/AD group, for example: objectclass=groupOfNames * ldap_group_gid -- The attribute used to name an LDAP/AD group, for example: cn * ldap_group_scope -- The scope to search for LDAP/AD groups. 0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE - 2. Or Change configure parameter in web console after installation. Go to "Administration" -> "Configuration" -> "Authentication" and change following settings. - - LDAP Group Base DN -- ldap_group_basedn in harbor.cfg - - LDAP Group Filter -- ldap_group_filter in harbor.cfg - - LDAP Group GID -- ldap_group_gid in harbor.cfg - - LDAP Group Scope -- ldap_group_scope in harbor.cfg + 2. Or change configure parameter in web console after installation. Go to "Administration" -> "Configuration" -> "Authentication" and change following settings. + - LDAP Group Base DN -- ldap_group_basedn in the Harbor user settings + - LDAP Group Filter -- ldap_group_filter in the Harbor user settings + - LDAP Group GID -- ldap_group_gid in the Harbor user settings + - LDAP Group Scope -- ldap_group_scope in the Harbor user settings - LDAP Groups With Admin Privilege -- Specify an LDAP/AD group DN, all LDAPA/AD users in this group have harbor admin privileges. ![Screenshot of LDAP group config](img/group/ldap_group_config.png)