summaryrefslogtreecommitdiff
path: root/keystoneclient/contrib
diff options
context:
space:
mode:
authorBrant Knudson <bknudson@us.ibm.com>2014-10-11 16:20:54 -0500
committerBrant Knudson <bknudson@us.ibm.com>2014-12-04 19:04:15 -0600
commit3c8d35247ebfc57663f363ba9522da27b8748262 (patch)
tree9608b4b767be52d66416f2e869a95424f3b2623e /keystoneclient/contrib
parentcc0c93fc0c4c5d0240a5a96c57f1fd62988ee6aa (diff)
downloadpython-keystoneclient-3c8d35247ebfc57663f363ba9522da27b8748262.tar.gz
Correct documenting constructor parameters
When the docs are rendered to HTML, any docs on __init__ are not displayed. The parameters to the constructor have to be documented on the class rather than on the __init__ method. Also, corrected other minor issues in the same areas. Change-Id: Ic56da33f6b99fe5efb636c289e3c4e1569f0c84c
Diffstat (limited to 'keystoneclient/contrib')
-rw-r--r--keystoneclient/contrib/auth/v3/saml2.py105
1 files changed, 50 insertions, 55 deletions
diff --git a/keystoneclient/contrib/auth/v3/saml2.py b/keystoneclient/contrib/auth/v3/saml2.py
index 5458ac1..69db21b 100644
--- a/keystoneclient/contrib/auth/v3/saml2.py
+++ b/keystoneclient/contrib/auth/v3/saml2.py
@@ -88,20 +88,38 @@ class Saml2UnscopedTokenAuthMethod(v3.AuthMethod):
class Saml2UnscopedToken(_BaseSAMLPlugin):
"""Implement authentication plugin for SAML2 protocol.
- ECP stands for ``Enhanced Client or Proxy`` and is a SAML2 extension
+ ECP stands for `Enhanced Client or Proxy` and is a SAML2 extension
for federated authentication where a transportation layer consists of
HTTP protocol and XML SOAP messages.
- Read for more information::
- ``https://wiki.shibboleth.net/confluence/display/SHIB2/ECP``
+ `Read for more information
+ <https://wiki.shibboleth.net/confluence/display/SHIB2/ECP>`_ on ECP.
- The SAML2 ECP specification can be found at::
- ``https://www.oasis-open.org/committees/download.php/
- 49979/saml-ecp-v2.0-wd09.pdf``
+ Reference the `SAML2 ECP specification <https://www.oasis-open.org/\
+ committees/download.php/49979/saml-ecp-v2.0-wd09.pdf>`_.
Currently only HTTPBasicAuth mechanism is available for the IdP
authenication.
+ :param auth_url: URL of the Identity Service
+ :type auth_url: string
+
+ :param identity_provider: name of the Identity Provider the client will
+ authenticate against. This parameter will be used
+ to build a dynamic URL used to obtain unscoped
+ OpenStack token.
+ :type identity_provider: string
+
+ :param identity_provider_url: An Identity Provider URL, where the SAML2
+ authn request will be sent.
+ :type identity_provider_url: string
+
+ :param username: User's login
+ :type username: string
+
+ :param password: User's password
+ :type password: string
+
"""
_auth_method_class = Saml2UnscopedTokenAuthMethod
@@ -149,27 +167,6 @@ class Saml2UnscopedToken(_BaseSAMLPlugin):
identity_provider_url,
username, password,
**kwargs):
- """Class constructor accepting following parameters:
- :param auth_url: URL of the Identity Service
- :type auth_url: string
-
- :param identity_provider: name of the Identity Provider the client
- will authenticate against. This parameter
- will be used to build a dynamic URL used to
- obtain unscoped OpenStack token.
- :type identity_provider: string
-
- :param identity_provider_url: An Identity Provider URL, where the SAML2
- authn request will be sent.
- :type identity_provider_url: string
-
- :param username: User's login
- :type username: string
-
- :param password: User's password
- :type password: string
-
- """
super(Saml2UnscopedToken, self).__init__(auth_url=auth_url, **kwargs)
self.identity_provider = identity_provider
self.identity_provider_url = identity_provider_url
@@ -438,7 +435,32 @@ class Saml2UnscopedToken(_BaseSAMLPlugin):
class ADFSUnscopedToken(_BaseSAMLPlugin):
- """Authentication plugin for Microsoft ADFS2.0 IdPs."""
+ """Authentication plugin for Microsoft ADFS2.0 IdPs.
+
+ :param auth_url: URL of the Identity Service
+ :type auth_url: string
+
+ :param identity_provider: name of the Identity Provider the client will
+ authenticate against. This parameter will be used
+ to build a dynamic URL used to obtain unscoped
+ OpenStack token.
+ :type identity_provider: string
+
+ :param identity_provider_url: An Identity Provider URL, where the SAML2
+ authentication request will be sent.
+ :type identity_provider_url: string
+
+ :param service_provider_endpoint: Endpoint where an assertion is being
+ sent, for instance: ``https://host.domain/Shibboleth.sso/ADFS``
+ :type service_provider_endpoint: string
+
+ :param username: User's login
+ :type username: string
+
+ :param password: User's password
+ :type password: string
+
+ """
_auth_method_class = Saml2UnscopedTokenAuthMethod
@@ -464,33 +486,6 @@ class ADFSUnscopedToken(_BaseSAMLPlugin):
def __init__(self, auth_url, identity_provider, identity_provider_url,
service_provider_endpoint, username, password, **kwargs):
- """Constructor for ``ADFSUnscopedToken``.
-
- :param auth_url: URL of the Identity Service
- :type auth_url: string
-
- :param identity_provider: name of the Identity Provider the client
- will authenticate against. This parameter
- will be used to build a dynamic URL used to
- obtain unscoped OpenStack token.
- :type identity_provider: string
-
- :param identity_provider_url: An Identity Provider URL, where the SAML2
- authentication request will be sent.
- :type identity_provider_url: string
-
- :param service_provider_endpoint: Endpoint where an assertion is being
- sent, for instance: ``https://host.domain/Shibboleth.sso/ADFS``
- :type service_provider_endpoint: string
-
- :param username: User's login
- :type username: string
-
- :param password: User's password
- :type password: string
-
- """
-
super(ADFSUnscopedToken, self).__init__(auth_url=auth_url, **kwargs)
self.identity_provider = identity_provider
self.identity_provider_url = identity_provider_url