summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Kanakarakis <ivan.kanak@gmail.com>2021-12-21 01:53:07 +0200
committerIvan Kanakarakis <ivan.kanak@gmail.com>2021-12-21 01:53:07 +0200
commit204b58264b170656af4645bfd4e10a88490d36d3 (patch)
tree146a2118352971fa70ae49348306478a1ab6b9e5
parent4122e36369bdd2340165425a6ca9ea237e592846 (diff)
downloadpysaml2-204b58264b170656af4645bfd4e10a88490d36d3.tar.gz
metadata: Document node_name option for the remote source
Signed-off-by: Ivan Kanakarakis <ivan.kanak@gmail.com>
-rw-r--r--docs/howto/config.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/howto/config.rst b/docs/howto/config.rst
index 0cbfcbf1..e2e4bc41 100644
--- a/docs/howto/config.rst
+++ b/docs/howto/config.rst
@@ -398,6 +398,12 @@ will be accepted as valid.
When the paramenter *disable_ssl_certificate_validation* is set to True the
validity of ssl certificate will be skipped.
+When using a remote metadata source, the `node_name` option can be set to
+define the name of the root node of the XML document, if needed. Usually,
+the node name will be `urn:oasis:names:tc:SAML:2.0:metadata:EntityDescriptor`
+or `urn:oasis:names:tc:SAML:2.0:metadata:EntityDescriptor` (node namespace
+and node tag name).
+
When using MDQ, the `freshness_period` option can be set to define a period for
which the metadata fetched from the the MDQ server are considered fresh. After
that period has passed the metadata are not valid anymore and must be fetched