keystoneauth1.identity.v2 模块

class keystoneauth1.identity.v2.Auth(auth_url: str, *, trust_id: str | None = None, tenant_id: str | None = None, tenant_name: str | None = None, reauthenticate: bool = True)

基础: BaseIdentityPlugin

身份验证 V2 插件。

参数：

• auth_url (string) – 授权的身份服务端点。

• trust_id (string) – 信任范围的信任 ID。

• tenant_id (字符串) – 项目范围的租户 ID。

• tenant_name (字符串) – 项目范围的租户名称。

• reauthenticate (bool) – 允许在当前令牌即将过期时获取新的令牌。（可选）默认值为 True

__abstractmethods__ = frozenset({'get_auth_data'})

__annotations__ = {'MIN_TOKEN_LIFE_SECONDS': 'int', '_discovery_cache': 'dict[str, discover.Discover]', 'auth_ref': 'access.AccessInfo | None', 'auth_url': <class 'str'>, 'reauthenticate': 'bool'}

__doc__ = '身份 V2 身份验证 插件。\n\n    :param 字符串 auth_url: 授权的身份服务端点。\n    :param 字符串 trust_id: 信任范围的信任 ID。\n    :param 字符串 tenant_id: 项目范围的租户 ID。\n    :param 字符串 tenant_name: 项目范围的租户名称。\n    :param 布尔值 reauthenticate: 如果当前令牌即将过期，则允许获取新的令牌。（可选）默认值为 True\n    '

__init__(auth_url: str, *, trust_id: str | None = None, tenant_id: str | None = None, tenant_name: str | None = None, reauthenticate: bool = True)

__module__ = 'keystoneauth1.identity.v2'

_abc_impl = <_abc._abc_data object>

auth_url: str

abstract get_auth_data(headers: MutableMapping[str, str] | None = None) → dict[str, object]

返回身份验证插件的身份验证部分。

参数：

headers (dict) – 将与身份验证请求一起发送的标头（如果插件需要添加标头）。

返回值:

用于身份验证类型的身份验证数据字典。

返回类型:

dict

get_auth_ref(session: Session) → AccessInfoV2

从 OpenStack Identity 服务获取令牌。

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

不应独立调用此函数，并预计通过 do_authenticate 函数调用。

如果插件缓存的 AccessInfo 对象无效，将调用此函数。因此，插件应始终在调用时获取新的 AccessInfo。如果您只想检索当前的身份验证数据，则应使用 get_access。

参数：

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

引发:

• keystoneauth1.exceptions.response.InvalidResponse – 返回的响应不合适。

• keystoneauth1.exceptions.http.HttpError – 来自无效 HTTP 响应的错误。

返回值:

令牌访问信息。

返回类型:

keystoneauth1.access.AccessInfo

property has_scope_parameters: bool

如果参数可用于创建作用域令牌，则返回 True。

class keystoneauth1.identity.v2.Password(auth_url: str, username: str | None | Unset = Unset.token, password: str | None = None, user_id: str | None | Unset = Unset.token, *, trust_id: str | None = None, tenant_id: str | None = None, tenant_name: str | None = None, reauthenticate: bool = True)

继承自 Auth

用于使用用户名和密码进行身份验证的插件。

必须提供用户名或 user_id。

参数：

• auth_url (string) – 授权的身份服务端点。

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

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

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

• trust_id (string) – 信任范围的信任 ID。

• tenant_id (字符串) – 租户范围的租户 ID。

• tenant_name (字符串) – 租户范围的租户名称。

• reauthenticate (bool) – 允许在当前令牌即将过期时获取新的令牌。（可选）默认值为 True

引发:

TypeError – 如果未提供 user_id 或用户名。

__abstractmethods__ = frozenset({})

__annotations__ = {'MIN_TOKEN_LIFE_SECONDS': 'int', '_discovery_cache': 'dict[str, discover.Discover]', 'auth_ref': 'access.AccessInfo | None', 'auth_url': 'str', 'reauthenticate': 'bool'}

__doc__ = '使用用户名和密码进行身份验证的插件。\n\n    必须提供用户名或 user_id。\n\n    :param 字符串 auth_url: 授权的身份服务端点。\n    :param 字符串 username: 用于身份验证的用户名。\n    :param 字符串 password: 用于身份验证的密码。\n    :param 字符串 user_id: 用于身份验证的用户 ID。\n    :param 字符串 trust_id: 信任范围的信任 ID。\n    :param 字符串 tenant_id: 租户范围的租户 ID。\n    :param 字符串 tenant_name: 租户范围的租户名称。\n    :param 布尔值 reauthenticate: 如果当前令牌即将过期，则允许获取新的令牌。（可选）默认值为 True\n\n    :引发 TypeError: 如果未提供 user_id 或用户名。\n    '

__init__(auth_url: str, username: str | None | Unset = Unset.token, password: str | None = None, user_id: str | None | Unset = Unset.token, *, trust_id: str | None = None, tenant_id: str | None = None, tenant_name: str | None = None, reauthenticate: bool = True)

__module__ = 'keystoneauth1.identity.v2'

_abc_impl = <_abc._abc_data object>

get_auth_data(headers: MutableMapping[str, str] | None = None) → dict[str, object]

返回身份验证插件的身份验证部分。

参数：

headers (dict) – 将与身份验证请求一起发送的标头（如果插件需要添加标头）。

返回值:

用于身份验证类型的身份验证数据字典。

返回类型:

dict

get_cache_id_elements() → dict[str, str | None]

获取使此身份验证插件唯一化的元素。

作为 get_cache_id 要求的一部分，我们需要确定此插件及其值的哪些方面构成唯一的元素。

插件希望允许缓存时应覆盖此方法。

返回值:

此插件的唯一属性和值。

返回类型:

一个扁平的字典，其中包含一个 str 键和一个 str 或 None 值。这需要我们将这些值馈送到哈希中。值为空的对在哈希 ID 中被忽略。

class keystoneauth1.identity.v2.Token(auth_url: str, token: str, *, trust_id: str | None = None, tenant_id: str | None = None, tenant_name: str | None = None, reauthenticate: bool = True)

继承自 Auth

使用现有令牌进行身份验证的插件。

参数：

• auth_url (string) – 授权的身份服务端点。

• token (字符串) – 用于身份验证的现有令牌。

• tenant_id (字符串) – 租户范围的租户 ID。

• tenant_name (字符串) – 租户范围的租户名称。

• trust_id (string) – 信任范围的信任 ID。

• reauthenticate (bool) – 允许在当前令牌即将过期时获取新的令牌。（可选）默认值为 True

__abstractmethods__ = frozenset({})

__annotations__ = {'MIN_TOKEN_LIFE_SECONDS': 'int', '_discovery_cache': 'dict[str, discover.Discover]', 'auth_ref': 'access.AccessInfo | None', 'auth_url': 'str', 'reauthenticate': 'bool'}

__doc__ = '使用现有令牌进行身份验证的插件。\n\n    :param 字符串 auth_url: 用于授权的身份服务端点。\n    :param 字符串 token: 用于身份验证的现有令牌。\n    :param 字符串 tenant_id: 用于租户范围的租户 ID。\n    :param 字符串 tenant_name: 用于租户范围的租户名称。\n    :param 字符串 trust_id: 用于信任范围的信任 ID。\n    :param 布尔值 reauthenticate: 如果当前令牌即将过期，则允许获取新的令牌。（可选）默认值为 True\n    '

__init__(auth_url: str, token: str, *, trust_id: str | None = None, tenant_id: str | None = None, tenant_name: str | None = None, reauthenticate: bool = True)

__module__ = 'keystoneauth1.identity.v2'

_abc_impl = <_abc._abc_data object>

get_auth_data(headers: MutableMapping[str, str] | None = None) → dict[str, object]

返回身份验证插件的身份验证部分。

参数：

headers (dict) – 将与身份验证请求一起发送的标头（如果插件需要添加标头）。

返回值:

用于身份验证类型的身份验证数据字典。

返回类型:

dict

get_cache_id_elements() → dict[str, str | None]

获取使此身份验证插件唯一化的元素。

作为 get_cache_id 要求的一部分，我们需要确定此插件及其值的哪些方面构成唯一的元素。

插件希望允许缓存时应覆盖此方法。

返回值:

此插件的唯一属性和值。

返回类型:

一个扁平的字典，其中包含一个 str 键和一个 str 或 None 值。这需要我们将这些值馈送到哈希中。值为空的对在哈希 ID 中被忽略。

class keystoneauth1.identity.v2.Unset(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基础: Enum

__doc__ = None

__module__ = 'keystoneauth1.identity.v2'

token = 0