diff options
author | Jenkins <jenkins@review.openstack.org> | 2015-01-28 20:17:04 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2015-01-28 20:17:04 +0000 |
commit | 019c383cb44dcdcdf478925627fd58eb4866d230 (patch) | |
tree | 5d14843536bbdce75314acf19f96eca2d93a038b | |
parent | e494e111c548ce34404c9bd375f90f4762986031 (diff) | |
parent | 764e42e55ed62ed39ebb117e0c7b3f3a44b9f12b (diff) | |
download | python-keystoneclient-019c383cb44dcdcdf478925627fd58eb4866d230.tar.gz |
Merge "Add auth plugin params to doc"
-rw-r--r-- | keystoneclient/auth/identity/v2.py | 10 | ||||
-rw-r--r-- | keystoneclient/auth/identity/v3.py | 34 |
2 files changed, 44 insertions, 0 deletions
diff --git a/keystoneclient/auth/identity/v2.py b/keystoneclient/auth/identity/v2.py index 995044f..bad0eac 100644 --- a/keystoneclient/auth/identity/v2.py +++ b/keystoneclient/auth/identity/v2.py @@ -107,6 +107,11 @@ class Password(Auth): :param string username: Username for authentication. :param string password: Password for authentication. :param string user_id: User ID for authentication. + :param string trust_id: Trust ID for trust scoping. + :param string tenant_id: Tenant ID for tenant scoping. + :param string tenant_name: Tenant name for tenant scoping. + :param bool reauthenticate: Allow fetching a new token if the current one + is going to expire. (optional) default True :raises TypeError: if a user_id or username is not provided. """ @@ -160,6 +165,11 @@ class Token(Auth): :param string auth_url: Identity service endpoint for authorization. :param string token: Existing token for authentication. + :param string tenant_id: Tenant ID for tenant scoping. + :param string tenant_name: Tenant name for tenant scoping. + :param string trust_id: Trust ID for trust scoping. + :param bool reauthenticate: Allow fetching a new token if the current one + is going to expire. (optional) default True """ def __init__(self, auth_url, token, **kwargs): diff --git a/keystoneclient/auth/identity/v3.py b/keystoneclient/auth/identity/v3.py index 0375c48..0f44a26 100644 --- a/keystoneclient/auth/identity/v3.py +++ b/keystoneclient/auth/identity/v3.py @@ -248,6 +248,25 @@ class PasswordMethod(AuthMethod): class Password(AuthConstructor): + """A plugin for authenticating with a username and password. + + :param string auth_url: Identity service endpoint for authentication. + :param string password: Password for authentication. + :param string username: Username for authentication. + :param string user_id: User ID for authentication. + :param string user_domain_id: User's domain ID for authentication. + :param string user_domain_name: User's domain name for authentication. + :param string trust_id: Trust ID for trust scoping. + :param string domain_id: Domain ID for domain scoping. + :param string domain_name: Domain name for domain scoping. + :param string project_id: Project ID for project scoping. + :param string project_name: Project name for project scoping. + :param string project_domain_id: Project's domain ID for project. + :param string project_domain_name: Project's domain name for project. + :param bool reauthenticate: Allow fetching a new token if the current one + is going to expire. (optional) default True + """ + _auth_method_class = PasswordMethod @classmethod @@ -280,6 +299,21 @@ class TokenMethod(AuthMethod): class Token(AuthConstructor): + """A plugin for authenticating with an existing Token. + + :param string auth_url: Identity service endpoint for authentication. + :param string token: Token for authentication. + :param string trust_id: Trust ID for trust scoping. + :param string domain_id: Domain ID for domain scoping. + :param string domain_name: Domain name for domain scoping. + :param string project_id: Project ID for project scoping. + :param string project_name: Project name for project scoping. + :param string project_domain_id: Project's domain ID for project. + :param string project_domain_name: Project's domain name for project. + :param bool reauthenticate: Allow fetching a new token if the current one + is going to expire. (optional) default True + """ + _auth_method_class = TokenMethod def __init__(self, auth_url, token, **kwargs): |