Skip to content

Commit b551c6c

Browse files
authored
Add note about attributes in newer versions of pysaml2 (#50)
1 parent 2ddf6f2 commit b551c6c

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ PLUGINS_CONFIG = {
6363

6464
# Settings for SAML2CustomAttrUserBackend. Optional.
6565
'CUSTOM_ATTR_BACKEND': {
66+
# See the note below about SAML attributes
67+
6668
# Attribute containing the username. Optional.
6769
'USERNAME_ATTR': 'http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress',
6870
# Attribute containing the user's email. Optional.
@@ -95,6 +97,15 @@ PLUGINS_CONFIG = {
9597
Please note that `METADATA_AUTO_CONF_URL` and `METADATA_LOCAL_FILE_PATH` are
9698
mutually exclusive. Don't use both settings at the same time.
9799

100+
## Attributes
101+
102+
Newer versions of `pysaml2` uses an attribute map.
103+
For example, instead of `http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress` in the configuration above, `emailAddress` should be used instead.
104+
105+
See [here](https://github.com/IdentityPython/pysaml2/tree/master/src/saml2/attributemaps) for details.
106+
107+
108+
98109
# New Plugin URLs
99110
This plugin will provide two new URLs to Netbox:
100111

0 commit comments

Comments
 (0)