Skip to content

feature: add docs for extra fields #11814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 2, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions security/ldap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ use the ``ldap`` user provider.
search_password: password
default_roles: ROLE_USER
uid_key: uid
extra_fields: ['email']

.. code-block:: xml

Expand Down Expand Up @@ -189,6 +190,7 @@ use the ``ldap`` user provider.
'search_password' => 'password',
'default_roles' => 'ROLE_USER',
'uid_key' => 'uid',
'extra_fields' => ['email'],
],
],
],
Expand Down Expand Up @@ -268,6 +270,15 @@ implementation. Commonly used values are:
If you pass ``null`` as the value of this option, the default UID key is used
``sAMAccountName``.

extra_fields
............

**type**: ``array`` **default**: ``null``

This is the custom fields to pull from the LDAP server. If the fields does not
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defines the custom fields...

... If any field does not exist, an Invalid... will be thrown.

exists it will throw an \InvalidArgumentException.


filter
......

Expand Down