keystoneclient.auth.identity.generic package

子模块

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)

基础类: BaseIdentityPlugin

一个不依赖版本的身份验证插件。

内部我们将使用解析后的 URL 构建一个依赖版本的插件，然后将来自基础插件的所有调用代理到版本化的插件。

abstractmethod create_plugin(session, version, url, raw_status=None)

创建一个插件，基于给定的参数。

此函数将多次调用，并带有潜在终结点的版本和 URL。如果可以构造一个符合参数的插件，则应返回它。如果不能，则将进行另一个调用，并使用其他可用的 URL。

参数：

  • session (keystoneclient.session.Session) – 一个会话对象。

  • version (tuple) – URL 处的 API 版本的元组。

  • url (string) – 此版本的基 URL。

  • raw_status (string) – 发现字段中的状态。

返回值:

一个可以匹配参数的插件，或者如果没有任何匹配项则返回 None。

get_auth_ref(session, **kwargs)

从 OpenStack Identity 服务获取令牌。

此方法由各种令牌版本插件覆盖。

不应独立调用此方法，并预计通过 do_authenticate() 方法调用。

如果插件缓存的 AccessInfo 对象无效，则将调用此方法。因此，插件在调用时应始终获取新的 AccessInfo。如果您只想检索当前的 auth 数据，则应使用 get_access()。

参数：

session (keystoneclient.session.Session) – 可以用于通信的会话对象。

引发:
返回值:

令牌访问信息。

返回类型:

keystoneclient.access.AccessInfo

classmethod get_options()

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

property trust_id

自 1.7.0 版本弃用。

可能在 2.0.0 版本中删除。

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)

基础类: Password

一个为 CLI 提供典型身份验证选项的插件。

此插件提供标准的用户名和密码身份验证选项，并允许用户使用自定义令牌和端点进行覆盖。

get_endpoint(*args, **kwargs)

返回服务的有效端点。

如果不存在有效的令牌，则将使用会话和 kwargs 获取新的令牌。

参数：

  • session (keystoneclient.session.Session) – 可以用于通信的会话对象。

  • service_type (string) – 要查找端点的服务类型。如果未提供 service_type，则此插件将返回 None（失败）。

  • interface (string) – 端点的暴露。应为 public、internal、admin 或 auth。auth 在这里是特殊的，用于使用 auth_url 而不是从服务目录中提取的 URL。默认为 public。

  • region_name (string) – 端点应存在的区域。（可选）

  • service_name (string) – 目录中的服务名称。（可选）

  • version (tuple) – 此端点所需的最低版本号。（可选）

引发:

keystoneclient.exceptions.HttpError – 来自无效 HTTP 响应的错误。

返回值:

有效的端点 URL 或不可用时为 None。

返回类型:

字符串或 None

classmethod get_options()

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

get_token(*args, **kwargs)

返回有效的身份验证 token。

如果不存在有效的 token，则将获取一个新的 token。

参数：

session (keystoneclient.session.Session) – 可以用于通信的会话对象。

引发:

keystoneclient.exceptions.HttpError – 来自无效 HTTP 响应的错误。

返回值:

一个有效的 token。

返回类型:

字符串

classmethod load_from_argparse_arguments(namespace, **kwargs)

从 argparse 结果加载特定的插件对象。

将解析结果转换为指定的插件。

参数：

namespace (argparse.Namespace) – CLI 解析的结果。

返回值:

一个认证插件，或者如果没有提供名称则为 None。

返回类型:

keystoneclient.auth.BaseAuthPlugin

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)

基础类: BaseGenericPlugin

一个通用的用户名/密码身份验证插件。

参数：

  • username (string) – 身份验证的用户名。

  • user_id (字符串) – 用于身份验证的用户 ID。

  • password (string) – 身份验证的密码。

  • user_domain_id (字符串) – 用于身份验证的用户的域 ID。

  • user_domain_name (字符串) – 用于身份验证的用户的域名称。

create_plugin(session, version, url, raw_status=None)

创建一个插件，基于给定的参数。

此函数将多次调用，并带有潜在终结点的版本和 URL。如果可以构造一个符合参数的插件，则应返回它。如果不能，则将进行另一个调用，并使用其他可用的 URL。

参数：

  • session (keystoneclient.session.Session) – 一个会话对象。

  • version (tuple) – URL 处的 API 版本的元组。

  • url (string) – 此版本的基 URL。

  • raw_status (string) – 发现字段中的状态。

返回值:

一个可以匹配参数的插件，或者如果没有任何匹配项则返回 None。

classmethod get_options()

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

classmethod load_from_argparse_arguments(namespace, **kwargs)

从 argparse 结果加载特定的插件对象。

将解析结果转换为指定的插件。

参数：

namespace (argparse.Namespace) – CLI 解析的结果。

返回值:

一个认证插件，或者如果没有提供名称则为 None。

返回类型:

keystoneclient.auth.BaseAuthPlugin

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)

基础类: BaseGenericPlugin

通用 Token 认证插件。

参数：

token (字符串) – 用于认证的 Token。

create_plugin(session, version, url, raw_status=None)

创建一个插件，基于给定的参数。

此函数将多次调用，并带有潜在终结点的版本和 URL。如果可以构造一个符合参数的插件，则应返回它。如果不能，则将进行另一个调用，并使用其他可用的 URL。

参数：

  • session (keystoneclient.session.Session) – 一个会话对象。

  • version (tuple) – URL 处的 API 版本的元组。

  • url (string) – 此版本的基 URL。

  • raw_status (string) – 发现字段中的状态。

返回值:

一个可以匹配参数的插件，或者如果没有任何匹配项则返回 None。

classmethod get_options()

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

keystoneclient.auth.identity.generic.token.get_options()

模块内容

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)

基础类: BaseIdentityPlugin

一个不依赖版本的身份验证插件。

内部我们将使用解析后的 URL 构建一个依赖版本的插件，然后将来自基础插件的所有调用代理到版本化的插件。

abstractmethod create_plugin(session, version, url, raw_status=None)

创建一个插件，基于给定的参数。

此函数将多次调用，并带有潜在终结点的版本和 URL。如果可以构造一个符合参数的插件，则应返回它。如果不能，则将进行另一个调用，并使用其他可用的 URL。

参数：

  • session (keystoneclient.session.Session) – 一个会话对象。

  • version (tuple) – URL 处的 API 版本的元组。

  • url (string) – 此版本的基 URL。

  • raw_status (string) – 发现字段中的状态。

返回值:

一个可以匹配参数的插件，或者如果没有任何匹配项则返回 None。

get_auth_ref(session, **kwargs)

从 OpenStack Identity 服务获取令牌。

此方法由各种令牌版本插件覆盖。

不应独立调用此方法，并预计通过 do_authenticate() 方法调用。

如果插件缓存的 AccessInfo 对象无效，则将调用此方法。因此，插件在调用时应始终获取新的 AccessInfo。如果您只想检索当前的 auth 数据，则应使用 get_access()。

参数：

session (keystoneclient.session.Session) – 可以用于通信的会话对象。

引发:
返回值:

令牌访问信息。

返回类型:

keystoneclient.access.AccessInfo

classmethod get_options()

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

property trust_id

自 1.7.0 版本弃用。

可能在 2.0.0 版本中删除。

class keystoneclient.auth.identity.generic.Password(auth_url, username=None, user_id=None, password=None, user_domain_id=None, user_domain_name=None, **kwargs)

基础类: BaseGenericPlugin

一个通用的用户名/密码身份验证插件。

参数：

  • username (string) – 身份验证的用户名。

  • user_id (字符串) – 用于身份验证的用户 ID。

  • password (string) – 身份验证的密码。

  • user_domain_id (字符串) – 用于身份验证的用户的域 ID。

  • user_domain_name (字符串) – 用于身份验证的用户的域名称。

create_plugin(session, version, url, raw_status=None)

创建一个插件，基于给定的参数。

此函数将多次调用，并带有潜在终结点的版本和 URL。如果可以构造一个符合参数的插件，则应返回它。如果不能，则将进行另一个调用，并使用其他可用的 URL。

参数：

  • session (keystoneclient.session.Session) – 一个会话对象。

  • version (tuple) – URL 处的 API 版本的元组。

  • url (string) – 此版本的基 URL。

  • raw_status (string) – 发现字段中的状态。

返回值:

一个可以匹配参数的插件，或者如果没有任何匹配项则返回 None。

classmethod get_options()

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表

classmethod load_from_argparse_arguments(namespace, **kwargs)

从 argparse 结果加载特定的插件对象。

将解析结果转换为指定的插件。

参数：

namespace (argparse.Namespace) – CLI 解析的结果。

返回值:

一个认证插件，或者如果没有提供名称则为 None。

返回类型:

keystoneclient.auth.BaseAuthPlugin

class keystoneclient.auth.identity.generic.Token(auth_url, token=None, **kwargs)

基础类: BaseGenericPlugin

通用 Token 认证插件。

参数：

token (字符串) – 用于认证的 Token。

create_plugin(session, version, url, raw_status=None)

创建一个插件，基于给定的参数。

此函数将多次调用，并带有潜在终结点的版本和 URL。如果可以构造一个符合参数的插件，则应返回它。如果不能，则将进行另一个调用，并使用其他可用的 URL。

参数：

  • session (keystoneclient.session.Session) – 一个会话对象。

  • version (tuple) – URL 处的 API 版本的元组。

  • url (string) – 此版本的基 URL。

  • raw_status (string) – 发现字段中的状态。

返回值:

一个可以匹配参数的插件，或者如果没有任何匹配项则返回 None。

classmethod get_options()

返回与身份验证插件关联的参数列表。

此列表可用于生成 CLI 或配置文件参数。

返回值:

描述可用插件参数的 Param 对象列表。

返回类型:

列表