You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/smartattributes.md
+39-36Lines changed: 39 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,28 +4,26 @@ SmartAttributes module
4
4
The SmartAttributes module provides authentication processing filters to add attributes.
5
5
The logic in this filter exceeds what is possible with the standard filters such, as [`core:AttributeAdd`], [`core:AttributeAlter`], and [`core:AttributeMap`].
6
6
7
-
8
-
9
7
`smartattributes:SmartID`
10
-
=========================
8
+
-------------------------
11
9
12
10
A filter to add an identifier attribute, based on the first non-empty attribute from a given list of attribute names.
13
11
This is useful when there are multiple SAML IdPs configured, and there is no common identifier among them.
14
12
For example some IdPs send eduPersonPrincipalName, while others send eduPersonTargetedID. If any of the social networks are configured as an authsource, they will send yet another identifier.
15
13
The filter has the following configuration options:
16
14
17
15
*`candidates`. An array of attributes names to consider as the identifier attribute. Defaults to:
18
-
* eduPersonTargetedID
19
-
* eduPersonPrincipalName
20
-
* pairwise-id
21
-
* subject-id
22
-
* openid
23
-
* facebook_targetedID
24
-
* twitter_targetedID
25
-
* windowslive_targetedID
26
-
* linkedin_targetedID
16
+
* eduPersonTargetedID
17
+
* eduPersonPrincipalName
18
+
* pairwise-id
19
+
* subject-id
20
+
* openid
21
+
* facebook_targetedID
22
+
* twitter_targetedID
23
+
* windowslive_targetedID
24
+
* linkedin_targetedID
27
25
*`id_attribute`. A string to use as the name of the newly added attribute. Defaults to `smart_id`.
28
-
*`add_authority`. A boolean to indicate whether or not to append the SAML AuthenticatingAuthority to the resulting identifier. This can be useful to indicate what SAML IdP was used, in case the original identifier is not scoped. Defaults to `TRUE`.
26
+
*`add_authority`. A boolean to indicate whether or not to append the SAML AuthenticatingAuthority to the resulting identifier. This can be useful to indicate what SAML IdP was used, in case the original identifier is not scoped. When multiple values are in the AuthenticatingAuthority element, the last (closest to us) will be used. Defaults to `TRUE`.
29
27
*`add_candidate`. A boolean to indicate whether or not to prepend the candidate attribute name to the resulting identifier. This can be useful to indicate the attribute originating the identifier. Defaults to `TRUE`.
30
28
*`fail_if_empty`. A boolean to indicate whether this module reports a failure if no suitable identifier attribute could be found. Set this to `FALSE` if a missing identifier attribute should be handled at a later step in the AuthProc filter queue. Defaults to `TRUE`.
31
29
@@ -42,43 +40,48 @@ Examples
42
40
43
41
Without any configuration:
44
42
45
-
'authproc' => array(
46
-
50 => array(
47
-
'class' => 'smartattributes:SmartID'
48
-
),
49
-
),
50
-
43
+
```php
44
+
'authproc' => [
45
+
50 => [
46
+
'class' => 'smartattributes:SmartID'
47
+
],
48
+
],
49
+
```
51
50
52
51
This will add an attribute called `smart_id` with a value looking like, for example:
0 commit comments