keystoneclient.auth.identity.generic package

Submodules

keystoneclient.auth.identity.generic.base module

class 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 dependant.

Internally we will construct a version dependant 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:
  • session (keystoneclient.session.Session) – A session object.
  • version (tuple) – A tuple of the API version at the URL.
  • url (string) – The base URL for this version.
  • raw_status (string) – The status that was in the discovery field.
Returns:

A plugin that can match the parameters or None if nothing.
get_auth_ref(session, **kwargs)
classmethod get_options()
trust_id
keystoneclient.auth.identity.generic.base.get_options()

keystoneclient.auth.identity.generic.cli module

class 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)
classmethod get_options()
get_token(*args, **kwargs)
classmethod load_from_argparse_arguments(namespace, **kwargs)

keystoneclient.auth.identity.generic.password module

class 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:
  • username (string) – Username for authentication.
  • user_id (string) – User ID for authentication.
  • password (string) – Password for authentication.
  • user_domain_id (string) – User’s domain ID for authentication.
  • user_domain_name (string) – User’s domain name for authentication.
create_plugin(session, version, url, raw_status=None)
classmethod get_options()
classmethod load_from_argparse_arguments(namespace, **kwargs)
keystoneclient.auth.identity.generic.password.get_options()

keystoneclient.auth.identity.generic.token module

class 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)
classmethod get_options()
keystoneclient.auth.identity.generic.token.get_options()

Module contents

class 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 dependant.

Internally we will construct a version dependant 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:
  • session (keystoneclient.session.Session) – A session object.
  • version (tuple) – A tuple of the API version at the URL.
  • url (string) – The base URL for this version.
  • raw_status (string) – The status that was in the discovery field.
Returns:

A plugin that can match the parameters or None if nothing.
get_auth_ref(session, **kwargs)
classmethod get_options()
trust_id
class 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:
  • username (string) – Username for authentication.
  • user_id (string) – User ID for authentication.
  • password (string) – Password for authentication.
  • user_domain_id (string) – User’s domain ID for authentication.
  • user_domain_name (string) – User’s domain name for authentication.
create_plugin(session, version, url, raw_status=None)
classmethod get_options()
classmethod load_from_argparse_arguments(namespace, **kwargs)
class 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)
classmethod get_options()