Identity API v2

有关如何使用身份验证的详细信息，请参阅 使用 OpenStack 身份验证

Identity v2 类

身份验证高级接口可通过 Connection 对象的 identity 成员获得。只有检测到该服务时，才会添加 identity 成员。

扩展操作

class openstack.identity.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
extensions()

检索扩展生成器

返回值:

扩展实例的生成器。

返回类型:

Extension

get_extension(extension)

获取单个扩展

参数：

extension – 该值可以是扩展的 ID 或 Extension 实例。

返回值:

一个 Extension

引发:

NotFoundException 在找不到扩展时引发。

用户操作

class openstack.identity.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_user(**attrs)

从属性创建新用户

参数：

attrs (dict) – 关键字参数，将用于创建 User，包含 User 类上的属性。

返回值:

用户创建的结果

返回类型:

用户

delete_user(user, ignore_missing=True)

删除一个用户

参数：

  • user – 该值可以是用户的 ID 或 User 实例。

  • ignore_missing (bool) – 当设置为 False 时，如果用户不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的用户时不会设置任何异常。

返回值:

无

find_user(name_or_id, ignore_missing=True)

查找单个用户

参数：

  • name_or_id – 用户的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个 User 或 None

get_user(user)

获取单个用户

参数：

user – 该值可以是用户的 ID 或 User 实例。

返回值:

一个 User

引发:

NotFoundException，当找不到资源时。

users(**query)

检索用户生成器

参数：

query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

用户实例的生成器。

返回类型:

用户

update_user(user, **attrs)

更新一个用户

参数：

  • user – 用户的 ID 或 User 实例。

  • attrs – 要更新由 user 表示的用户上的属性。

返回值:

更新后的用户

返回类型:

用户

角色操作

class openstack.identity.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_role(**attrs)

从属性创建新角色

参数：

attrs (dict) – 关键字参数，将用于创建 Role，包含 Role 类上的属性。

返回值:

角色创建的结果

返回类型:

角色

delete_role(role, ignore_missing=True)

删除一个角色

参数：

  • role – 该值可以是角色的 ID 或 Role 实例。

  • ignore_missing (bool) – 当设置为 False 时，如果角色不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的角色时不会设置任何异常。

返回值:

无

find_role(name_or_id, ignore_missing=True)

查找单个角色

参数：

  • name_or_id – 角色的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个 Role 或 None

get_role(role)

获取单个角色

参数：

role – 该值可以是角色的 ID 或 Role 实例。

返回值:

一个 Role

引发:

NotFoundException，当找不到资源时。

roles(**query)

检索角色生成器

参数：

query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

角色实例的生成器。

返回类型:

角色

update_role(role, **attrs)

更新角色

参数：

  • role – 用户的 ID 或 Role 实例。

  • attrs – 要更新由 role 表示的角色上的属性。

返回值:

更新后的角色

返回类型:

角色

租户操作

class openstack.identity.v2._proxy.Proxy(session, *, service_type=None, service_name=None, interface=None, region_name=None, endpoint_override=None, version=None, auth=None, user_agent=None, connect_retries=None, logger=None, allow=None, additional_headers=None, client_name=None, client_version=None, allow_version_hack=None, global_request_id=None, min_version=None, max_version=None, default_microversion=None, status_code_retries=None, retriable_status_codes=None, raise_exc=None, rate_limit=None, concurrency=None, connect_retry_delay=None, status_code_retry_delay=None, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None)
create_tenant(**attrs)

从属性创建新租户

参数：

attrs (dict) – 关键字参数，将用于创建 Tenant，包含 Tenant 类上的属性。

返回值:

租户创建的结果

返回类型:

Tenant

delete_tenant(tenant, ignore_missing=True)

删除租户

参数：

  • tenant – 该值可以是租户的 ID，也可以是一个 Tenant 实例。

  • ignore_missing (bool) – 当设置为 False 时，如果租户不存在，将引发 NotFoundException 异常。当设置为 True 时，尝试删除一个不存在的租户将不会引发任何异常。

返回值:

无

find_tenant(name_or_id, ignore_missing=True)

查找单个租户

参数：

  • name_or_id – 租户的名称或 ID。

  • ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个 Tenant 或 None

get_tenant(tenant)

获取单个租户

参数：

tenant – 该值可以是租户的 ID，也可以是一个 Tenant 实例。

返回值:

一个 Tenant

引发:

NotFoundException，当找不到资源时。

tenants(**query)

检索租户生成器

参数：

query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

一个租户实例的生成器。

返回类型:

Tenant

update_tenant(tenant, **attrs)

更新租户

参数：

  • tenant – 租户的 ID 或一个 Tenant 实例。

  • attrs – 要更新到由 tenant 表示的租户上的属性。

返回值:

更新后的租户

返回类型:

Tenant