diff options
| author | Marek Denis <marek.denis@cern.ch> | 2015-04-24 17:04:12 +0200 |
|---|---|---|
| committer | Marek Denis <marek.denis@cern.ch> | 2015-05-21 19:15:54 +0200 |
| commit | af9d954ef55ee50b076fd2437560ff794b3d682c (patch) | |
| tree | 46fe17a731b0bddc3813373847426cadf1eb7243 /keystoneclient/auth | |
| parent | 841e634aceae0b483fb32f3cd9b8e3a99d662bad (diff) | |
| download | python-keystoneclient-af9d954ef55ee50b076fd2437560ff794b3d682c.tar.gz | |
Add docstrings for ``protocol`` parameter
Parameter ``protocol`` was missing docstrings in the __init__.
Also, config help is very poor.
This patch fixes both issues.
Change-Id: Ia2cfee9ba6aa5f4ca036c008bcfe03ff9113c7a3
Diffstat (limited to 'keystoneclient/auth')
| -rw-r--r-- | keystoneclient/auth/identity/v3/federated.py | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/keystoneclient/auth/identity/v3/federated.py b/keystoneclient/auth/identity/v3/federated.py index db7ad2b..f6416eb 100644 --- a/keystoneclient/auth/identity/v3/federated.py +++ b/keystoneclient/auth/identity/v3/federated.py @@ -31,11 +31,14 @@ class FederatedBaseAuth(base.BaseAuth): :param auth_url: URL of the Identity Service :type auth_url: string - :param identity_provider: name of the Identity Provider the client + :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 protocol: Protocol name configured on the keystone service + provider side + :type protocol: string """ super(FederatedBaseAuth, self).__init__(auth_url=auth_url, **kwargs) @@ -49,8 +52,12 @@ class FederatedBaseAuth(base.BaseAuth): options.extend([ cfg.StrOpt('identity-provider', help="Identity Provider's name"), - cfg.StrOpt('protocol', - help='Protocol for federated plugin'), + cfg.StrOpt('protocol', help="Name of the federated protocol used " + "for federated authentication. Must " + "match its counterpart name " + "configured at the keystone service " + "provider. Typically values would be " + "'saml2' or 'oidc'.") ]) return options |