Skip to content

Commit 40c5452

Browse files
committed
Docstring explanation of the NameID element
1 parent e5ef95b commit 40c5452

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

src/saml2/saml.py

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -811,7 +811,16 @@ def base_id_from_string(xml_string):
811811

812812

813813
class NameID(NameIDType_):
814-
"""The urn:oasis:names:tc:SAML:2.0:assertion:NameID element """
814+
"""The urn:oasis:names:tc:SAML:2.0:assertion:NameID element
815+
816+
From the Oasis SAML2 Technical Overview:
817+
818+
"The <NameID> element within a <Subject> offers the ability to provide name
819+
identifiers in a number of different formats. SAML's predefined formats
820+
include: Email address, X.509 subject name, Windows domain qualified name,
821+
Kerberos principal name, Entity identifier, Persistent identifier,
822+
Transient identifier."
823+
"""
815824

816825
c_tag = 'NameID'
817826
c_namespace = NAMESPACE

0 commit comments

Comments
 (0)