Skip to content

Commit e8b7bf7

Browse files
daviftorresDavi Torres
and
Davi Torres
authored
Updating LDAP integration instructions in table format (apache#494)
Co-authored-by: Davi Torres <[email protected]>
1 parent 0b91e0a commit e8b7bf7

File tree

1 file changed

+59
-45
lines changed

1 file changed

+59
-45
lines changed

source/adminguide/accounts.rst

Lines changed: 59 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -481,36 +481,74 @@ to be applied through the API call described above.
481481
482482
483483
In addition to those shown in the example script above, the following
484-
configuration items can be configured (the default values are for
485-
openldap)
484+
configuration items can be configured on a Global or on a per Domain level (the default values are for
485+
OpenLDAP)
486486

487-
- ``ldap.basedn``: Sets the basedn for LDAP. Ex: **OU=APAC,DC=company,DC=com**
488-
489-
- ``ldap.bind.principal``, ``ldap.bind.password``: DN and password for a User
490-
who can list all the Users in the above basedn. Ex:
491-
**CN=Administrator, OU=APAC, DC=company, DC=com**
487+
.. list-table:: LDAP Settings
488+
:header-rows: 1
492489

493-
- ``ldap.user.object``: object type of Users within LDAP. Defaults value is
494-
**user** for AD and **interorgperson** for openldap.
490+
* - Setting
491+
- OpenLDAP
492+
- Active Directory
493+
- Description
494+
* - ``ldap.basedn``
495+
- `Ex: OU=APAC, DC=company, DC=com`
496+
- `Ex: DC=company, DC=com`
497+
- Sets the basedn for LDAP.
498+
* - ``ldap.search.group.principle``
499+
- `Ex: CN=ACSGroup, DC=company, DC=com`
500+
- `Ex: CN=ACSGroup, CN=Users, DC=company, DC=com`
501+
- (optional) if set only Users from this group are listed.
502+
* - ``ldap.bind.principal``
503+
- `Ex: CN=ACSServiceAccount, OU=APAC, DC=company, DC=com`
504+
- `Ex: CN=ACSServiceAccount, CN=Users, DC=company, DC=com`
505+
- Service account that can list all the Users in the above basedn. Avoid using privileged account such as Administrator.
506+
* - ``ldap.bind.password``
507+
- `******************`
508+
- `******************`
509+
- Password for a DN User. Is entered in plain text but gets stored encrypted.
510+
* - ``ldap.user.object``
511+
- `interorgperson`
512+
- `user`
513+
- Object type of Users within LDAP.
514+
* - ``ldap.email.attribute``
515+
- `mail`
516+
- `mail`
517+
- Email attribute within ldap for a User.
518+
* - ``ldap.firstname.attribute``
519+
- `givenname`
520+
- `givenname`
521+
- firstname attribute within ldap for a User.
522+
* - ``ldap.lastname.attribute``
523+
- `sn`
524+
- `sn`
525+
- lastname attribute within ldap for a User.
526+
* - ``ldap.group.object``
527+
- `groupOfUniqueNames`
528+
- `groupOfUniqueNames`
529+
- Object type of groups within LDAP.
530+
* - ``ldap.group.user.uniquemember``
531+
- `uniquemember`
532+
- `uniquemember`
533+
- Attribute for uniquemembers within a group.
534+
535+
536+
Once configured, on Add Account page, you will see an "Add LDAP Account" button which opens a dialog and the selected Users can be imported.
495537

496-
- ``ldap.email.attribute``: email attribute within ldap for a User. Default
497-
value for AD and openldap is **mail**.
538+
.. figure:: /_static/images/CloudStack-ldap-screen1.png
539+
:align: center
498540

499-
- ``ldap.firstname.attribute``: firstname attribute within ldap for a User.
500-
Default value for AD and openldap is **givenname**.
501541

502-
- ``ldap.lastname.attribute``: lastname attribute within ldap for a User.
503-
Default value for AD and openldap is **sn**.
542+
You could also use api commands:
543+
``listLdapUsers``, to list Users in LDAP that could or would be imported in CloudStack
544+
``ldapCreateAccount``, to manually create a User in a specific Account
545+
``importLdapUsers``, to batch import Users from LDAP
504546

505-
- ``ldap.username.attribute``: username attribute for a User within LDAP.
506-
Default value is **SAMAccountName** for AD and **uid** for openldap.
547+
Once LDAP is enabled, the Users will not be allowed to changed password
548+
directly in CloudStack.
507549

508550

509-
Restricting LDAP Users to a group:
510-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
511551

512-
- ``ldap.search.group.principle``: this is optional and if set only Users from
513-
this group are listed.
514552

515553

516554
LDAP SSL:
@@ -524,30 +562,6 @@ You will need to know the path to the keystore and the password.
524562
- ``ldap.truststore.password`` : truststore password
525563

526564

527-
LDAP groups:
528-
~~~~~~~~~~~~
529-
530-
- ``ldap.group.object``: object type of groups within LDAP. Default value is
531-
group for AD and **groupOfUniqueNames** for openldap.
532-
533-
- ``ldap.group.user.uniquemember``: attribute for uniquemembers within a group.
534-
Default value is **member** for AD and **uniquemember** for openldap.
535-
536-
Once configured, on Add Account page, you will see an "Add LDAP Account" button
537-
which opens a dialog and the selected Users can be imported.
538-
539-
.. figure:: /_static/images/CloudStack-ldap-screen1.png
540-
:align: center
541-
542-
543-
You could also use api commands:
544-
``listLdapUsers``, to list Users in LDAP that could or would be imported in CloudStack
545-
``ldapCreateAccount``, to manually create a User in a specific Account
546-
``importLdapUsers``, to batch import Users from LDAP
547-
548-
Once LDAP is enabled, the Users will not be allowed to changed password
549-
directly in CloudStack.
550-
551565
.. |button to dedicate a zone, pod,cluster, or host| image:: /_static/images/dedicate-resource-button.png
552566

553567
Using a SAML 2.0 Identity Provider for User Authentication

0 commit comments

Comments
 (0)