keystoneauth1.token_endpoint 模块

class keystoneauth1.token_endpoint.Token(endpoint: str | None, token: str | None)

基类: BaseAuthPlugin

一个提供程序,将始终使用给定的令牌和端点。

这仅在测试以及在某些 CLI 情况下有用,在这些情况下,您拥有已知的端点和管理员令牌,并且希望使用它们。

__annotations__ = {}
__doc__ = '一个 提供程序 ,它 始终 使用 给定的 令牌 端点。\n\n    测试 以及 某些 CLI 情况下 有用 ,在 这些情况下 ,您\n    拥有 一个 已知的 端点 管理员 令牌 ,并且 希望 使用 它们。\n    '
__init__(endpoint: str | None, token: str | None)
__module__ = 'keystoneauth1.token_endpoint'
get_auth_ref(session: ks_session.Session) access.AccessInfo | None

返回身份验证插件的身份验证引用。

参数:

session (keystoneauth1.session.session) – 用于通信的会话对象

get_endpoint(session: ks_session.Session, **kwargs: Any) str | None

返回提供的端点。

使用此插件,无论传递给插件的参数如何,都将返回相同的端点。

get_endpoint_data(session: ks_session.Session, *, endpoint_override: str | None = None, discover_versions: bool = True, **kwargs: Any) EndpointData | None

返回服务的有效端点数据。

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

  • endpoint_override (str) – 用于版本发现的其他于插件中存储的端点的 URL。(可选,默认为 None)

  • discover_versions (bool) – 即使可以从 URL 推断出主要 API 版本信息,是否从版本发现文档获取版本元数据。(可选,默认为 True)

  • kwargs – 已忽略。

引发:

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

返回值:

有效的 EndpointData 或不可用的 None。

返回类型:

keystoneauth1.discover.EndpointData 或 None

get_token(session: ks_session.Session) str | None

获取令牌。

令牌的获取方式由插件决定。如果它仍然有效,则可以重用、从缓存中检索或调用服务器上的身份验证请求。

返回 None 将指示无法检索到令牌。

此函数放置不当,因为它仅应需要使用“X-Auth-Token”标头的身份验证插件。但是,由于插件的演变方式,此方法是必需的,并且通常被调用以触发新插件上的身份验证请求。

在实现新插件时,建议您实现此方法,但是,如果您不需要“X-Auth-Token”标头,请改写 get_headers 方法。

参数:

session (keystoneauth1.session.Session) – 一个会话对象,以便插件可以进行 HTTP 调用。

返回值:

要使用的令牌。

返回类型:

字符串