summaryrefslogtreecommitdiff
path: root/src/saml2/saml.py
diff options
context:
space:
mode:
authorIvan Kanakarakis <ivan.kanak@gmail.com>2018-08-24 10:15:47 +0300
committerGitHub <noreply@github.com>2018-08-24 10:15:47 +0300
commit9eb34a9b048b5897d41db730ab3d9ab777465554 (patch)
tree4d5aa77750e6f3343d7575db2f8d8587ac97ed1b /src/saml2/saml.py
parent7135d985aa49d17b0bcc4a433a363da945e3b0ab (diff)
parent40c5452dcd38ba20d6a8cefb56ba2a8e146921ad (diff)
downloadpysaml2-9eb34a9b048b5897d41db730ab3d9ab777465554.tar.gz
Merge pull request #538 from sheilatron/Docstrings4Learning
Improve docstring for NameID and argtree.add_path
Diffstat (limited to 'src/saml2/saml.py')
-rw-r--r--src/saml2/saml.py11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/saml2/saml.py b/src/saml2/saml.py
index 8807966c..023f352f 100644
--- a/src/saml2/saml.py
+++ b/src/saml2/saml.py
@@ -811,7 +811,16 @@ def base_id_from_string(xml_string):
class NameID(NameIDType_):
- """The urn:oasis:names:tc:SAML:2.0:assertion:NameID element """
+ """The urn:oasis:names:tc:SAML:2.0:assertion:NameID element
+
+ From the Oasis SAML2 Technical Overview:
+
+ "The <NameID> element within a <Subject> offers the ability to provide name
+ identifiers in a number of different formats. SAML's predefined formats
+ include: Email address, X.509 subject name, Windows domain qualified name,
+ Kerberos principal name, Entity identifier, Persistent identifier,
+ Transient identifier."
+ """
c_tag = 'NameID'
c_namespace = NAMESPACE