keystoneclient.auth.identity.generic.base.
BaseGenericPlugin
(auth_url, tenant_id=None, tenant_name=None, project_id=None, project_name=None, project_domain_id=None, project_domain_name=None, domain_id=None, domain_name=None, trust_id=None)¶Bases: keystoneclient.auth.identity.base.BaseIdentityPlugin
An identity plugin that is not version dependent.
Internally we will construct a version dependent plugin with the resolved URL and then proxy all calls from the base plugin to the versioned one.
create_plugin
(session, version, url, raw_status=None)¶Create a plugin from the given parameters.
This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.
Parameters: |
|
---|---|
Returns: | A plugin that can match the parameters or None if nothing. |
get_auth_ref
(session, **kwargs)¶Obtain a token from an OpenStack Identity Service.
This method is overridden by the various token version plugins.
This method should not be called independently and is expected to be invoked via the do_authenticate() method.
This method will be invoked if the AccessInfo object cached by the plugin is not valid. Thus plugins should always fetch a new AccessInfo when invoked. If you are looking to just retrieve the current auth data then you should use get_access().
Parameters: | session (keystoneclient.session.Session) – A session object that can be used for communication. |
---|---|
Raises: |
|
Returns: | Token access information. |
Return type: |
get_options
()¶Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
Returns: | A list of Param objects describing available plugin parameters. |
---|---|
Return type: | List |
trust_id
¶keystoneclient.auth.identity.generic.base.
get_options
()¶keystoneclient.auth.identity.generic.cli.
DefaultCLI
(endpoint=None, token=None, **kwargs)¶Bases: keystoneclient.auth.identity.generic.password.Password
A Plugin that provides typical authentication options for CLIs.
This plugin provides standard username and password authentication options as well as allowing users to override with a custom token and endpoint.
get_endpoint
(*args, **kwargs)¶Return a valid endpoint for a service.
If a valid token is not present then a new one will be fetched using the session and kwargs.
Parameters: |
|
---|---|
Raises: | keystoneclient.exceptions.HttpError – An error from an invalid HTTP response. |
Returns: | A valid endpoint URL or None if not available. |
Return type: | string or None |
get_options
()¶Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
Returns: | A list of Param objects describing available plugin parameters. |
---|---|
Return type: | List |
get_token
(*args, **kwargs)¶Return a valid auth token.
If a valid token is not present then a new one will be fetched.
Parameters: | session (keystoneclient.session.Session) – A session object that can be used for communication. |
---|---|
Raises: | keystoneclient.exceptions.HttpError – An error from an invalid HTTP response. |
Returns: | A valid token. |
Return type: | string |
load_from_argparse_arguments
(namespace, **kwargs)¶Load a specific plugin object from an argparse result.
Convert the results of a parse into the specified plugin.
Parameters: | namespace (argparse.Namespace) – The result from CLI parsing. |
---|---|
Returns: | An auth plugin, or None if a name is not provided. |
Return type: | keystoneclient.auth.BaseAuthPlugin |
keystoneclient.auth.identity.generic.password.
Password
(auth_url, username=None, user_id=None, password=None, user_domain_id=None, user_domain_name=None, **kwargs)¶Bases: keystoneclient.auth.identity.generic.base.BaseGenericPlugin
A common user/password authentication plugin.
Parameters: |
|
---|
create_plugin
(session, version, url, raw_status=None)¶Create a plugin from the given parameters.
This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.
Parameters: |
|
---|---|
Returns: | A plugin that can match the parameters or None if nothing. |
get_options
()¶Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
Returns: | A list of Param objects describing available plugin parameters. |
---|---|
Return type: | List |
load_from_argparse_arguments
(namespace, **kwargs)¶Load a specific plugin object from an argparse result.
Convert the results of a parse into the specified plugin.
Parameters: | namespace (argparse.Namespace) – The result from CLI parsing. |
---|---|
Returns: | An auth plugin, or None if a name is not provided. |
Return type: | keystoneclient.auth.BaseAuthPlugin |
keystoneclient.auth.identity.generic.password.
get_options
()¶keystoneclient.auth.identity.generic.token.
Token
(auth_url, token=None, **kwargs)¶Bases: keystoneclient.auth.identity.generic.base.BaseGenericPlugin
Generic token auth plugin.
Parameters: | token (string) – Token for authentication. |
---|
create_plugin
(session, version, url, raw_status=None)¶Create a plugin from the given parameters.
This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.
Parameters: |
|
---|---|
Returns: | A plugin that can match the parameters or None if nothing. |
get_options
()¶Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
Returns: | A list of Param objects describing available plugin parameters. |
---|---|
Return type: | List |
keystoneclient.auth.identity.generic.token.
get_options
()¶keystoneclient.auth.identity.generic.
BaseGenericPlugin
(auth_url, tenant_id=None, tenant_name=None, project_id=None, project_name=None, project_domain_id=None, project_domain_name=None, domain_id=None, domain_name=None, trust_id=None)¶Bases: keystoneclient.auth.identity.base.BaseIdentityPlugin
An identity plugin that is not version dependent.
Internally we will construct a version dependent plugin with the resolved URL and then proxy all calls from the base plugin to the versioned one.
create_plugin
(session, version, url, raw_status=None)¶Create a plugin from the given parameters.
This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.
Parameters: |
|
---|---|
Returns: | A plugin that can match the parameters or None if nothing. |
get_auth_ref
(session, **kwargs)¶Obtain a token from an OpenStack Identity Service.
This method is overridden by the various token version plugins.
This method should not be called independently and is expected to be invoked via the do_authenticate() method.
This method will be invoked if the AccessInfo object cached by the plugin is not valid. Thus plugins should always fetch a new AccessInfo when invoked. If you are looking to just retrieve the current auth data then you should use get_access().
Parameters: | session (keystoneclient.session.Session) – A session object that can be used for communication. |
---|---|
Raises: |
|
Returns: | Token access information. |
Return type: |
get_options
()¶Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
Returns: | A list of Param objects describing available plugin parameters. |
---|---|
Return type: | List |
trust_id
¶keystoneclient.auth.identity.generic.
Password
(auth_url, username=None, user_id=None, password=None, user_domain_id=None, user_domain_name=None, **kwargs)¶Bases: keystoneclient.auth.identity.generic.base.BaseGenericPlugin
A common user/password authentication plugin.
Parameters: |
|
---|
create_plugin
(session, version, url, raw_status=None)¶Create a plugin from the given parameters.
This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.
Parameters: |
|
---|---|
Returns: | A plugin that can match the parameters or None if nothing. |
get_options
()¶Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
Returns: | A list of Param objects describing available plugin parameters. |
---|---|
Return type: | List |
load_from_argparse_arguments
(namespace, **kwargs)¶Load a specific plugin object from an argparse result.
Convert the results of a parse into the specified plugin.
Parameters: | namespace (argparse.Namespace) – The result from CLI parsing. |
---|---|
Returns: | An auth plugin, or None if a name is not provided. |
Return type: | keystoneclient.auth.BaseAuthPlugin |
keystoneclient.auth.identity.generic.
Token
(auth_url, token=None, **kwargs)¶Bases: keystoneclient.auth.identity.generic.base.BaseGenericPlugin
Generic token auth plugin.
Parameters: | token (string) – Token for authentication. |
---|
create_plugin
(session, version, url, raw_status=None)¶Create a plugin from the given parameters.
This function will be called multiple times with the version and url of a potential endpoint. If a plugin can be constructed that fits the params then it should return it. If not return None and then another call will be made with other available URLs.
Parameters: |
|
---|---|
Returns: | A plugin that can match the parameters or None if nothing. |
get_options
()¶Return the list of parameters associated with the auth plugin.
This list may be used to generate CLI or config arguments.
Returns: | A list of Param objects describing available plugin parameters. |
---|---|
Return type: | List |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.