openstack/python-keystoneclient
Code Issues Proposed changes

Merge "Add docstrings for `protocol` parameter"

Browse Source
This commit is contained in:
Jenkins
2015-05-22 18:07:35 +00:00
committed by Gerrit Code Review
parent c2461d09be af9d954ef5
commit d3b1f637e2
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
keystoneclient/auth/identity/v3/federated.py
View File

@@ -31,11 +31,14 @@ class FederatedBaseAuth(base.BaseAuth):
:param auth_url: URL of the Identity Service :param auth_url: URL of the Identity Service
:type auth_url: string :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 authenticate against. This parameter
will be used to build a dynamic URL used to will be used to build a dynamic URL used to
obtain unscoped OpenStack token. obtain unscoped OpenStack token.
:type identity_provider: string :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) super(FederatedBaseAuth, self).__init__(auth_url=auth_url, **kwargs)
@@ -49,8 +52,12 @@ class FederatedBaseAuth(base.BaseAuth):
options.extend([ options.extend([
cfg.StrOpt('identity-provider', cfg.StrOpt('identity-provider',
help="Identity Provider's name"), help="Identity Provider's name"),
cfg.StrOpt('protocol', cfg.StrOpt('protocol', help="Name of the federated protocol used "
help='Protocol for federated plugin'), "for federated authentication. Must "
"match its counterpart name "
"configured at the keystone service "
"provider. Typically values would be "
"'saml2' or 'oidc'.")
]) ])
return options return options