keystoneauth1.access package

子模块

• keystoneauth1.access.access module
• keystoneauth1.access.service_catalog module
• keystoneauth1.access.service_providers module
• keystoneauth1.access.types module

模块内容

class keystoneauth1.access.AccessInfo(body: dict[str, Any], auth_token: str | None = None)

基类: object

封装来自 keystone 的原始身份验证令牌。

提供从该令牌中提取有用值的辅助方法。

__annotations__ = {'_data': typing.Any, '_service_catalog_class': type[keystoneauth1.access.service_catalog.ServiceCatalog]}

__dict__ = mappingproxy({'__module__': 'keystoneauth1.access.access', '__annotations__': {'_service_catalog_class': type[keystoneauth1.access.service_catalog.ServiceCatalog], '_data': typing.Any, '_service_catalog': 'service_catalog.ServiceCatalog | None', '_service_providers': 'service_providers.ServiceProviders | None'}, '__doc__': '封装来自 keystone 的原始认证令牌。\n\n    提供用于从该令牌中提取有用值的辅助方法。\n    ', '__init__': <function AccessInfo.__init__>, 'service_catalog': <property object>, 'will_expire_soon': <function AccessInfo.will_expire_soon>, 'has_service_catalog': <function AccessInfo.has_service_catalog>, 'auth_token': <property object>, 'expires': <property object>, 'issued': <property object>, 'username': <property object>, 'user_id': <property object>, 'user_domain_id': <property object>, 'user_domain_name': <property object>, 'role_ids': <property object>, 'role_names': <property object>, 'domain_name': <property object>, 'domain_id': <property object>, 'project_name': <property object>, 'tenant_name': <property object>, 'scoped': <property object>, 'project_scoped': <property object>, 'domain_scoped': <property object>, 'system_scoped': <property object>, 'trust_id': <property object>, 'trust_scoped': <property object>, 'trustee_user_id': <property object>, 'trustor_user_id': <property object>, 'project_id': <property object>, 'tenant_id': <property object>, 'project_domain_id': <property object>, 'project_domain_name': <property object>, 'oauth_access_token_id': <property object>, 'oauth_consumer_id': <property object>, 'is_federated': <property object>, 'is_admin_project': <property object>, 'audit_id': <property object>, 'audit_chain_id': <property object>, 'initial_audit_id': <property object>, 'service_providers': <property object>, 'bind': <property object>, 'project_is_domain': <property object>, '__dict__': <attribute '__dict__' of 'AccessInfo' objects>, '__weakref__': <attribute '__weakref__' of 'AccessInfo' objects>})

__doc__ = '封装来自 keystone 的原始认证令牌。\n\n    提供用于从该令牌中提取有用值的辅助方法。\n    '

__init__(body: dict[str, Any], auth_token: str | None = None)

__module__ = 'keystoneauth1.access.access'

__weakref__

对该对象的弱引用列表

_data: Any

_service_catalog_class: type[ServiceCatalog]

property audit_chain_id: str | None

如果存在，则返回审计链 ID。

如果令牌被重新限定范围，则此 ID 将是初始令牌的 audit_id。 如果没有值，则返回 None。

返回值:

str 或 None。

property audit_id: str | None

如果存在，则返回审计 ID。

返回值:

str 或 None。

property auth_token: str | None

返回与身份验证请求关联的 token_id。

用于在 OpenStack API 请求中进行身份验证的标头。

返回值:

str

property bind: dict[str, Any] | None

有关令牌绑定的外部机制的信息。

如果令牌绑定到外部身份验证机制，则它只能与该机制一起使用。 例如，如果绑定到 Kerberos 主体，则只有在请求上执行 Kerberos 身份验证时才能接受它。

返回值:

字典或 None。 键将是绑定类型，值是特定于绑定类型格式的字典。 如果令牌中没有绑定信息，则返回 None。

property domain_id: str | None

返回与身份验证请求关联的域 ID。

返回值:

str 或 None（如果令牌没有关联域）

property domain_name: str | None

返回与身份验证请求关联的域名称。

返回值:

str 或 None（如果令牌没有关联域）

property domain_scoped: bool

如果身份验证令牌限定到域，则返回 True。

返回值:

bool

property expires: datetime | None

返回令牌过期时间（作为 datetime 对象）。

返回值:

datetime

has_service_catalog() → bool

如果认证令牌具有服务目录，则返回 True。

返回值:

布尔值

property initial_audit_id: str | None

最初请求的令牌的审计 ID。

如果存在，则为 audit_chain_id，否则为 audit_id。

property is_admin_project: bool

如果当前项目范围是管理项目，则返回 True。

为了向后兼容，如果令牌中未指定任何内容，我们始终假定我们在管理项目中，因此默认值为 True。

:returns 布尔值

property is_federated: bool

如果使用联合身份验证获取令牌，则返回 True。

返回值:

布尔值

property issued: datetime | None

返回令牌签发时间（作为 datetime 对象）。

返回值:

datetime

property oauth_access_token_id: str | None

如果使用 OAuth 身份验证，则返回访问令牌 ID。

返回值:

str 或 None。

property oauth_consumer_id: str | None

如果使用 OAuth 身份验证，则返回消费者 ID。

返回值:

str 或 None。

property project_domain_id: str | None

返回与身份验证请求关联的项目域 ID。

返回值:

str

property project_domain_name: str | None

返回与身份验证请求关联的项目域名称。

返回值:

str

property project_id: str | None

返回与身份验证请求关联的项目 ID。

如果身份验证令牌未限定到项目，则返回 None。

返回值:

字符串或 None（如果令牌未关联项目）

property project_is_domain: bool | None

返回项目是否充当域。

返回值:

bool

property project_name: str | None

返回与身份验证请求关联的项目名称。

返回值:

字符串或 None（如果令牌未关联项目）

property project_scoped: bool

如果身份验证令牌限定到租户（项目），则返回 True。

返回值:

bool

property role_ids: list[str] | None

返回与身份验证请求关联的用户角色 ID 列表。

返回值:

角色 ID 字符串列表

property role_names: list[str] | None

返回与身份验证请求关联的用户角色名称列表。

返回值:

角色名称字符串列表

property scoped: bool

如果身份验证令牌已限定范围，则返回 True。

如果限定到租户（项目）或域，并且包含填充的服务目录，则返回 true。

已弃用，请使用 project_scoped 代替。

返回值:

bool

property service_catalog: ServiceCatalog

property service_providers: ServiceProviders | None

返回表示受信任服务提供商列表的对象。

用于 Keystone2Keystone 联合身份验证。

返回值:

keystoneauth1.service_providers.ServiceProviders 或 None

property system_scoped: bool

如果身份验证令牌限定到系统，则返回 True。

返回值:

bool

property tenant_id: str | None

project_id 的同义词。

property tenant_name: str | None

project_name 的同义词。

property trust_id: str | None

返回与身份验证请求关联的信任 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property trust_scoped: bool

如果身份验证令牌来自委托信任，则返回 True。

信任委托通过 OS-TRUST v3 扩展实现。

返回值:

bool

property trustee_user_id: str | None

返回与信任关联的委托人用户 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property trustor_user_id: str | None

返回与信任关联的信托人用户 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property user_domain_id: str | None

返回与身份验证请求关联的用户域 ID。

返回值:

str

property user_domain_name: str | None

返回与身份验证请求关联的用户域名称。

返回值:

str

property user_id: str | None

返回与身份验证请求关联的用户 ID。

返回值:

str

property username: str | None

返回与身份验证请求关联的用户名。

遵循 V2 API 中定义的模式，首先查找“name”，如果可用则返回该名称，否则回退到“username”。

返回值:

str

will_expire_soon(stale_duration: int = 30) → bool

确定是否即将过期。

返回值:

如果过期时间在给定的持续时间内，则返回 True

返回类型:

布尔值

class keystoneauth1.access.AccessInfoV2(body: dict[str, Any], auth_token: str | None = None)

基础: AccessInfo

一个对象，用于封装来自身份服务的原始 v2 身份验证令牌。

__annotations__ = {'_data': <class 'keystoneauth1.access.types.TokenResponseV2'>}

__doc__ = '一个 对象 ，用于 封装 来自 身份 服务的 原始 v2 身份验证 令牌。'

__module__ = 'keystoneauth1.access.access'

_data: TokenResponseV2

_service_catalog_class

的别名 ServiceCatalogV2

property _token: TokenV2

property _trust: TrustV2 | None

property _user: UserV2

property audit_chain_id: str | None

如果存在，则返回审计链 ID。

如果令牌被重新限定范围，则此 ID 将是初始令牌的 audit_id。 如果没有值，则返回 None。

返回值:

str 或 None。

property audit_id: str | None

如果存在，则返回审计 ID。

返回值:

str 或 None。

property auth_token: str | None

返回与身份验证请求关联的 token_id。

用于在 OpenStack API 请求中进行身份验证的标头。

返回值:

str

property bind: dict[str, Any] | None

有关令牌绑定的外部机制的信息。

如果令牌绑定到外部身份验证机制，则它只能与该机制一起使用。 例如，如果绑定到 Kerberos 主体，则只有在请求上执行 Kerberos 身份验证时才能接受它。

返回值:

字典或 None。 键将是绑定类型，值是特定于绑定类型格式的字典。 如果令牌中没有绑定信息，则返回 None。

property domain_id: str | None

返回与身份验证请求关联的域 ID。

返回值:

str 或 None（如果令牌没有关联域）

property domain_name: str | None

返回与身份验证请求关联的域名称。

返回值:

str 或 None（如果令牌没有关联域）

property domain_scoped: bool

如果身份验证令牌限定到域，则返回 True。

返回值:

bool

property expires: datetime | None

返回令牌过期时间（作为 datetime 对象）。

返回值:

datetime

has_service_catalog() → bool

如果认证令牌具有服务目录，则返回 True。

返回值:

布尔值

property is_admin_project: bool

如果当前项目范围是管理项目，则返回 True。

为了向后兼容，如果令牌中未指定任何内容，我们始终假定我们在管理项目中，因此默认值为 True。

:returns 布尔值

property is_federated: bool

如果使用联合身份验证获取令牌，则返回 True。

返回值:

布尔值

property issued: datetime | None

返回令牌签发时间（作为 datetime 对象）。

返回值:

datetime

property oauth_access_token_id: str | None

如果使用 OAuth 身份验证，则返回访问令牌 ID。

返回值:

str 或 None。

property oauth_consumer_id: str | None

如果使用 OAuth 身份验证，则返回消费者 ID。

返回值:

str 或 None。

property project_domain_id: str | None

返回与身份验证请求关联的项目域 ID。

返回值:

str

property project_domain_name: str | None

返回与身份验证请求关联的项目域名称。

返回值:

str

property project_id: str | None

返回与身份验证请求关联的项目 ID。

如果身份验证令牌未限定到项目，则返回 None。

返回值:

字符串或 None（如果令牌未关联项目）

property project_is_domain: bool | None

返回项目是否充当域。

返回值:

bool

property project_name: str | None

返回与身份验证请求关联的项目名称。

返回值:

字符串或 None（如果令牌未关联项目）

property role_ids: list[str] | None

返回与身份验证请求关联的用户角色 ID 列表。

返回值:

角色 ID 字符串列表

property role_names: list[str] | None

返回与身份验证请求关联的用户角色名称列表。

返回值:

角色名称字符串列表

property service_providers: ServiceProviders | None

返回表示受信任服务提供商列表的对象。

用于 Keystone2Keystone 联合身份验证。

返回值:

keystoneauth1.service_providers.ServiceProviders 或 None

property system_scoped: bool

如果身份验证令牌限定到系统，则返回 True。

返回值:

bool

property trust_id: str | None

返回与身份验证请求关联的信任 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property trust_scoped: bool

如果身份验证令牌来自委托信任，则返回 True。

信任委托通过 OS-TRUST v3 扩展实现。

返回值:

bool

property trustee_user_id: str | None

返回与信任关联的委托人用户 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property trustor_user_id: str | None

返回与信任关联的信托人用户 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property user_domain_id: str | None

返回与身份验证请求关联的用户域 ID。

返回值:

str

property user_domain_name: str | None

返回与身份验证请求关联的用户域名称。

返回值:

str

property user_id: str | None

返回与身份验证请求关联的用户 ID。

返回值:

str

property username: str | None

返回与身份验证请求关联的用户名。

遵循 V2 API 中定义的模式，首先查找“name”，如果可用则返回该名称，否则回退到“username”。

返回值:

str

version = 'v2.0'

class keystoneauth1.access.AccessInfoV3(body: dict[str, Any], auth_token: str | None = None)

基础: AccessInfo

一个对象，封装来自身份服务的原始 v3 身份验证令牌。

__annotations__ = {'_data': <class 'keystoneauth1.access.types.TokenResponseV3'>}

__doc__ = '一个 对象 ，封装 来自 身份 服务的 原始 v3 身份验证 令牌。'

__module__ = 'keystoneauth1.access.access'

property _application_credential: ApplicationCredentialV3 | None

_data: TokenResponseV3

property _domain: DomainV3 | None

property _oauth: OAuth1V3 | None

property _oauth2_credential: OAuth2V3 | None

property _project: ProjectV3 | None

property _project_domain: ProjectDomainV3 | None

_service_catalog_class

的别名 ServiceCatalogV3

property _token: TokenV3

property _trust: TrustV3 | None

property _user: UserV3

property _user_domain: UserDomainV3

property application_credential: ApplicationCredentialV3

property application_credential_access_rules: list[ApplicationCredentialAccessRuleV3] | None

property application_credential_id: str | None

property audit_chain_id: str | None

如果存在，则返回审计链 ID。

如果令牌被重新限定范围，则此 ID 将是初始令牌的 audit_id。 如果没有值，则返回 None。

返回值:

str 或 None。

property audit_id: str | None

如果存在，则返回审计 ID。

返回值:

str 或 None。

property bind: dict[str, Any] | None

有关令牌绑定的外部机制的信息。

如果令牌绑定到外部身份验证机制，则它只能与该机制一起使用。 例如，如果绑定到 Kerberos 主体，则只有在请求上执行 Kerberos 身份验证时才能接受它。

返回值:

字典或 None。 键将是绑定类型，值是特定于绑定类型格式的字典。 如果令牌中没有绑定信息，则返回 None。

property domain_id: str | None

返回与身份验证请求关联的域 ID。

返回值:

str 或 None（如果令牌没有关联域）

property domain_name: str | None

返回与身份验证请求关联的域名称。

返回值:

str 或 None（如果令牌没有关联域）

property domain_scoped: bool

如果身份验证令牌限定到域，则返回 True。

返回值:

bool

property expires: datetime | None

返回令牌过期时间（作为 datetime 对象）。

返回值:

datetime

has_service_catalog() → bool

如果认证令牌具有服务目录，则返回 True。

返回值:

布尔值

property is_admin_project: bool

如果当前项目范围是管理项目，则返回 True。

为了向后兼容，如果令牌中未指定任何内容，我们始终假定我们在管理项目中，因此默认值为 True。

:returns 布尔值

property is_federated: bool

如果使用联合身份验证获取令牌，则返回 True。

返回值:

布尔值

property issued: datetime | None

返回令牌签发时间（作为 datetime 对象）。

返回值:

datetime

property oauth2_credential: OAuth2V3

property oauth2_credential_thumbprint: str | None

property oauth_access_token_id: str | None

如果使用 OAuth 身份验证，则返回访问令牌 ID。

返回值:

str 或 None。

property oauth_consumer_id: str | None

如果使用 OAuth 身份验证，则返回消费者 ID。

返回值:

str 或 None。

property project_domain_id: str | None

返回与身份验证请求关联的项目域 ID。

返回值:

str

property project_domain_name: str | None

返回与身份验证请求关联的项目域名称。

返回值:

str

property project_id: str | None

返回与身份验证请求关联的项目 ID。

如果身份验证令牌未限定到项目，则返回 None。

返回值:

字符串或 None（如果令牌未关联项目）

property project_is_domain: bool | None

返回项目是否充当域。

返回值:

bool

property project_name: str | None

返回与身份验证请求关联的项目名称。

返回值:

字符串或 None（如果令牌未关联项目）

property role_ids: list[str] | None

返回与身份验证请求关联的用户角色 ID 列表。

返回值:

角色 ID 字符串列表

property role_names: list[str] | None

返回与身份验证请求关联的用户角色名称列表。

返回值:

角色名称字符串列表

property service_providers: ServiceProviders | None

返回表示受信任服务提供商列表的对象。

用于 Keystone2Keystone 联合身份验证。

返回值:

keystoneauth1.service_providers.ServiceProviders 或 None

property system: SystemV3 | None

property system_scoped: bool

如果身份验证令牌限定到系统，则返回 True。

返回值:

bool

property trust_id: str | None

返回与身份验证请求关联的信任 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property trust_scoped: bool

如果身份验证令牌来自委托信任，则返回 True。

信任委托通过 OS-TRUST v3 扩展实现。

返回值:

bool

property trustee_user_id: str | None

返回与信任关联的委托人用户 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property trustor_user_id: str | None

返回与信任关联的信托人用户 ID。

返回值:

字符串或 None（如果令牌未关联信任）

property user_domain_id: str | None

返回与身份验证请求关联的用户域 ID。

返回值:

str

property user_domain_name: str | None

返回与身份验证请求关联的用户域名称。

返回值:

str

property user_id: str | None

返回与身份验证请求关联的用户 ID。

返回值:

str

property username: str | None

返回与身份验证请求关联的用户名。

遵循 V2 API 中定义的模式，首先查找“name”，如果可用则返回该名称，否则回退到“username”。

返回值:

str

version = 'v3'

keystoneauth1.access.create(resp: Response | None = None, body: dict[str, object] | None = None, auth_token: str | None = None) → AccessInfo