summaryrefslogtreecommitdiffstats
path: root/modules/core/docs/authproc_attributerealm.md
blob: 77b0bb31c2ac9aafb98e0ef0cc2a5940456b3219 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
`core:AttributeRealm`
=====================

This filter creates a new attribute with the realm of the user.

The new attribute is names `realm` by default, but can be controlled by the `attributename` option.
The realm is extracted from the attribute set as the user ID (eduPersonPrincipalName by default).
The user ID attribute can be changed with the `userid.attribute` option in the IdP metadata.

Examples
--------

Create the `realm` attribute.

    'authproc' => array(
        50 => array(
            'class' => 'core:AttributeRealm',
        ),
    ),

Set the `schacHomeOrganization` attribute.

    'authproc' => array(
        50 => array(
            'class' => 'core:AttributeRealm',
            'attributename' => 'schacHomeOrganization',
        ),
    ),