Skip to content

Commit 6a7c7fa

Browse files
author
ivan
committed
Add documentation for requested_attributes configuration option
1 parent 5ca4fb0 commit 6a7c7fa

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

doc/howto/config.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,52 @@ Example::
511511
This is relevant only for the eIDAS SAML profile.
512512

513513

514+
requested_attributes
515+
""""""""""""""""""""
516+
517+
A list of attributes that the SP requires from an eIDAS-Service (IdP).
518+
Each attribute is an object with the following attributes:
519+
520+
* friendly_name
521+
* name
522+
* required
523+
* name_format
524+
525+
Where friendly_name is an attribute name such as *DateOfBirth*, name is the
526+
full attribute name such as
527+
*http://eidas.europa.eu/attributes/naturalperson/DateOfBirth*, required
528+
indicates whether this attributed is required for authentication, and
529+
name_format indicates the name format for that attribute, such as
530+
*urn:oasis:names:tc:SAML:2.0:attrname-format:uri*.
531+
532+
It is mandatory that at least name or friendly_name is set.
533+
By default attributes are assumed to be required.
534+
Missing attributes are infered based on the attribute maps data.
535+
536+
Example::
537+
538+
"service": {
539+
"sp": {
540+
"requested_attributes": [
541+
{
542+
"name": "http://eidas.europa.eu/attributes/naturalperson/PersonIdentifier",
543+
},
544+
{
545+
"friendly_name": "DateOfBirth",
546+
"required": False,
547+
},
548+
],
549+
}
550+
}
551+
552+
.. note::
553+
This is relevant only for the eIDAS SAML profile.
554+
555+
This option is different from the required_attributes and
556+
optional_attributes parameters that control the requested
557+
attributes in the metadata of an SP.
558+
559+
514560
idp
515561
"""
516562

0 commit comments

Comments
 (0)