saml:NameIDAttribute
Filter that extracts the NameID we received in the authentication response and adds it as an attribute.
Parameters
-
attribute -
The name of the attribute we should create.
The default is
nameid. -
format -
The format string for the attribute.
The default is
%I!%S!%V.
The format string accepts the following replacements:
-
%I: The IdP that issued the NameID. This will be theNameQualifierelement of the NameID if it is present, or the entity ID of the IdP we received the response from if not. -
%S: The SP the NameID was issued to. This will be theSPNameQualifierelement of the NameID if it is present, or the entity ID of this SP otherwise. -
%V: The value of the NameID. -
%F: The format of the NameID. -
%%: Will be replaced with a single%.
Examples
Minimal configuration:
'default-sp' => [
'saml:SP',
'authproc' => [
20 => 'saml:NameIDAttribute',
],
],
Custom attribute name:
'default-sp' => [
'saml:SP',
'authproc' => [
20 => [
'class' => 'saml:NameIDAttribute',
'attribute' => 'someattributename',
],
],
],
Only extract the value of the NameID.
'default-sp' => [
'saml:SP',
'authproc' => [
20 => [
'class' => 'saml:NameIDAttribute',
'format' => '%V',
],
],
],