Identity API v3¶

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

Identity v3 类¶

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

凭证操作¶

class openstack.identity.v3._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_credential(**attrs)

创建新的凭证

参数：: attrs (dict) – 关键字参数，将用于创建 Credential，包含 Credential 类上的属性。
返回值:: 凭证创建的结果
返回类型:: Credential

delete_credential(credential, ignore_missing=True)

删除凭证

参数：

credential – 该值可以是凭证的 ID 或 Credential 实例。
ignore_missing (bool) – 当设置为 False 时，如果凭证不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的凭证将不会引发异常。

返回值:

无

find_credential(name_or_id, ignore_missing=True)

查找单个凭证

参数：

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

返回值:

一个 Credential 或 None

get_credential(credential)

获取单个凭证

参数：: credential – 该值可以是凭证的 ID 或 Credential 实例。
返回值:: 一个 Credential
引发:: NotFoundException，当找不到资源时。

credentials(**query)

检索凭证生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 凭证实例的生成器。
返回类型:: Credential

update_credential(credential, **attrs)

更新凭证

参数：

credential – 凭证的 ID 或 Credential 实例。
attrs – 要更新的属性，表示为 credential。

返回值:

更新后的凭证

返回类型:

Credential

域操作¶

create_domain(**attrs)

从属性创建新的域

参数：: attrs (dict) – 关键字参数，将用于创建 Domain，包含 Domain 类上的属性。
返回值:: 域创建的结果
返回类型:: 域

delete_domain(domain, ignore_missing=True)

删除域

参数：

domain – 该值可以是域的 ID 或 Domain 实例。
ignore_missing (bool) – 当设置为 False 时，如果域不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的域将不会引发异常。

返回值:

无

find_domain(name_or_id, ignore_missing=True)

查找单个域

参数：

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

返回值:

一个 Domain 或 None

get_domain(domain)

获取单个域

参数：: domain – 该值可以是域的 ID 或 Domain 实例。
返回值:: 一个 Domain
引发:: NotFoundException，当找不到资源时。

domains(**query)

检索域生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 域实例的生成器。
返回类型:: 域

update_domain(domain, **attrs)

更新域

参数：

domain – 域的 ID 或 Domain 实例。
attrs – 要更新的属性，表示为 domain。

返回值:

更新后的域

返回类型:

域

域配置操作¶

create_domain_config(domain, **attrs)

从属性创建新的域配置。

参数：

domain – 该值可以是域的 ID 或 Domain 实例。
attrs (dict) – 关键字参数，将用于创建 DomainConfig，包含 DomainConfig 类上的属性。

返回值:

域配置创建的结果

返回类型:

DomainConfig

delete_domain_config(domain, ignore_missing=True)

删除域的配置

参数：

domain – 该值可以是域的 ID 或 Domain 实例。
ignore_missing (bool) – 如果设置为 False，当身份提供程序不存在时，将引发 NotFoundException。如果设置为 True，则在尝试删除域中不存在的配置时，将不会设置任何异常。

返回值:

无

get_domain_config(domain)

获取域的单个配置

参数：: domain_id – 该值可以是域的 ID，也可以是 Domain 实例。
返回值:: 一个 DomainConfig
引发:: NotFoundException，当找不到资源时。

update_domain_config(domain, **attrs)

更新域的配置

参数：

domain_id – 该值可以是域的 ID，也可以是 Domain 实例。
attrs – 要更新的属性，表示由 domain_id 表示的域的配置。

返回值:

更新后的域配置

返回类型:

DomainConfig

Endpoint 操作¶

create_endpoint(**attrs)

从属性创建新的 endpoint

参数：: attrs (dict) – 关键字参数，将用于创建 Endpoint，包含 Endpoint 类上的属性。
返回值:: endpoint 创建的结果
返回类型:: 端点

delete_endpoint(endpoint, ignore_missing=True)

删除一个 endpoint

参数：

endpoint – 该值可以是 endpoint 的 ID，也可以是 Endpoint 实例。
ignore_missing (bool) – 如果设置为 False，当 endpoint 不存在时，将引发 NotFoundException。如果设置为 True，则在尝试删除不存在的 endpoint 时，将不会设置任何异常。

返回值:

无

find_endpoint(name_or_id, ignore_missing=True)

查找单个 endpoint

参数：

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

返回值:

一个 Endpoint 或 None

get_endpoint(endpoint)

获取单个 endpoint

参数：: endpoint – 该值可以是 endpoint 的 ID，也可以是 Endpoint 实例。
返回值:: 一个 Endpoint
引发:: NotFoundException，当找不到资源时。

endpoints(**query)

检索 endpoint 生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: endpoint 实例的生成器。
返回类型:: 端点

update_endpoint(endpoint, **attrs)

更新一个 endpoint

参数：

endpoint – endpoint 的 ID 或 Endpoint 实例。
attrs – 要更新的属性，表示由 endpoint 表示的 endpoint。

返回值:

更新后的 endpoint

返回类型:

端点

project_endpoints(project, **query)

检索与项目关联的 endpoint 生成器。

参数：

project – 项目 ID 或 Project 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

endpoint 实例的生成器。

返回类型:

ProjectEndpoint

associate_endpoint_with_project(project, endpoint)

创建项目和 endpoint 之间的直接关联

参数：

project – 项目 ID 或 Project 实例。
endpoint – endpoint 的 ID 或 Endpoint 实例。

返回值:

无

disassociate_endpoint_from_project(project, endpoint)

移除项目和 endpoint 之间的直接关联

参数：

project – 项目 ID 或 Project 实例。
endpoint – endpoint 的 ID 或 Endpoint 实例。

返回值:

无

Group 操作¶

create_group(**attrs)

从属性创建新的 group

参数：: attrs (dict) – 关键字参数，将用于创建 Group，包含 Group 类上的属性。
返回值:: group 创建的结果
返回类型:: Group

delete_group(group, ignore_missing=True)

删除一个组

参数：

group – 该值可以是 group 的 ID，也可以是 Group 实例。
ignore_missing (bool) – 如果设置为 False，当 group 不存在时，将引发 NotFoundException。如果设置为 True，则在尝试删除不存在的 group 时，将不会设置任何异常。

返回值:

无

find_group(name_or_id, ignore_missing=True, **query)

查找单个 group

参数：

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

返回值:

一个 Group 或 None

get_group(group)

获取单个 group

参数：: group – 该值可以是 group 的 ID，也可以是 Group 实例。
返回值:: 一个 Group
引发:: NotFoundException，当找不到资源时。

groups(**query)

检索 group 生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: group 实例的生成器。
返回类型:: Group

update_group(group, **attrs)

更新一个 group

参数：

group – group 的 ID 或 Group 实例。
attrs – 要更新的属性，表示由 group 表示的 group。

返回值:

更新后的 group

返回类型:

Group

add_user_to_group(user, group)

将用户添加到组

参数：

user – 用户 ID 或 User 实例。
group – group 的 ID 或 Group 实例。

返回值:

无

remove_user_from_group(user, group)

移除用户到 group

参数：

user – 用户 ID 或 User 实例。
group – group 的 ID 或 Group 实例。

返回值:

无

check_user_in_group(user, group)

检查用户是否属于 group

参数：

user – 用户 ID 或 User 实例。
group – group 的 ID 或 Group 实例。

返回值:

表示当前关系的布尔值

group_users(group, **attrs)

列出 group 中的用户

参数：

group – group 的 ID 或 Group 实例。
attrs – 只能过滤结果中的 password_expires_at。

返回值:

User 列表

Policy 操作¶

create_policy(**attrs)

从属性创建新的 policy

参数：: attrs (dict) – 关键字参数，将用于创建 Policy，包含 Policy 类上的属性。
返回值:: policy 创建的结果
返回类型:: 策略

delete_policy(policy, ignore_missing=True)

删除一个 policy

参数：

policy – 该值可以是 policy 的 ID，也可以是 Policy 实例。
ignore_missing (bool) – 如果设置为 False，当 policy 不存在时，将引发 NotFoundException。如果设置为 True，则在尝试删除不存在的 policy 时，将不会设置任何异常。

返回值:

无

find_policy(name_or_id, ignore_missing=True)

查找单个 policy

参数：

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

返回值:

一个 Policy 或 None

get_policy(policy)

获取单个 policy

参数：: policy – 该值可以是 policy 的 ID，也可以是 Policy 实例。
返回值:: 一个 Policy
引发:: NotFoundException，当找不到资源时。

policies(**query)

检索 policy 生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: policy 实例的生成器。
返回类型:: 策略

update_policy(policy, **attrs)

更新一个 policy

参数：

policy – 策略的 ID 或 Policy 实例。
attrs – 要更新由 policy 表示的策略的属性。

返回值:

更新后的策略

返回类型:

策略

项目操作¶

create_project(**attrs)

从属性创建新项目

参数：: attrs (dict) – 用于创建 Project 的关键字参数，包含 Project 类上的属性。
返回值:: 项目创建的结果
返回类型:: 项目

delete_project(project, ignore_missing=True)

删除一个项目

参数：

project – 该值可以是项目的 ID 或 Project 实例。
ignore_missing (bool) – 如果设置为 False，当项目不存在时将引发 NotFoundException。如果设置为 True，则在尝试删除不存在的项目时不会设置任何异常。

返回值:

无

find_project(name_or_id, ignore_missing=True, **query)

查找单个项目

参数：

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

返回值:

一个 Project 或 None

get_project(project)

获取单个项目

参数：: project – 该值可以是项目的 ID 或 Project 实例。
返回值:: 一个 Project
引发:: NotFoundException，当找不到资源时。

projects(**query)

检索项目生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 项目实例的生成器。
返回类型:: 项目

user_projects(user, **query)

检索用户有权访问的项目生成器: 访问。

参数：

user – 用户 ID 或 User 的实例
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

项目实例的生成器。

返回类型:

UserProject

endpoint_projects(endpoint, **query)

检索与端点关联的项目生成器。

参数：

endpoint – 端点 ID 或 Endpoint 的实例
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

项目实例的生成器。

返回类型:

EndpointProject

update_project(project, **attrs)

更新一个项目

参数：

project – 项目 ID 或 Project 实例。
attrs – 要更新由 project 表示的项目属性。

返回值:

更新后的项目

返回类型:

项目

服务操作¶

create_service(**attrs)

从属性创建新服务

参数：: attrs (dict) – 用于创建 Service 的关键字参数，包含 Service 类上的属性。
返回值:: 服务创建的结果
返回类型:: 服务

delete_service(service, ignore_missing=True)

删除服务

参数：

service – 该值可以是服务的 ID 或 Service 实例。
ignore_missing (bool) – 如果设置为 False，当服务不存在时将引发 NotFoundException。如果设置为 True，则在尝试删除不存在的服务时不会设置任何异常。

返回值:

无

find_service(name_or_id, ignore_missing=True)

查找单个服务

参数：

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

返回值:

一个 Service 或 None

get_service(service)

获取单个服务

参数：: service – 该值可以是服务的 ID 或 Service 实例。
返回值:: 一个 Service
引发:: NotFoundException，当找不到资源时。

services(**query)

检索服务生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 服务实例的生成器。
返回类型:: 服务

update_service(service, **attrs)

更新服务

参数：

service – 服务的 ID 或 Service 实例。
attrs – 要更新由 service 表示的服务的属性。

返回值:

更新后的服务

返回类型:

服务

用户操作¶

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, **query)

查找单个用户

参数：

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

返回值:

一个 User 或 None

get_user(user)

获取单个用户

参数：: user – 该值可以是用户的 ID 或 User 实例。
返回值:: 一个 User
引发:: NotFoundException，当找不到资源时。

user_groups(user)

列出用户所属的组

参数：: user – 用户的 ID 或 User 实例
返回值:: group 列表

users(**query)

检索用户生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 用户实例的生成器。
返回类型:: 用户

update_user(user, **attrs)

更新一个用户

参数：

user – 用户 ID 或 User 实例。
attrs – 要更新由 attrs 表示的用户的属性。

返回值:

更新后的用户

返回类型:

用户

信任操作¶

create_trust(**attrs)

从属性创建新信任

参数：: attrs (dict) – 用于创建 Trust 的关键字参数，包含 Trust 类上的属性。
返回值:: 信任创建的结果
返回类型:: 信任

delete_trust(trust, ignore_missing=True)

删除信任

参数：

trust – 该值可以是信任的 ID 或 Trust 实例。
ignore_missing (bool) – 当设置为 False 时，如果凭证不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的凭证将不会引发异常。

返回值:

无

find_trust(name_or_id, ignore_missing=True)

查找单个信任

参数：

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

返回值:

一个 Trust 或 None

get_trust(trust)

获取单个信任

参数：: trust – 该值可以是信任的 ID 或一个 Trust 实例。
返回值:: 一个 Trust
引发:: NotFoundException，当找不到资源时。

trusts(**query)

检索信任生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 信任实例的生成器。
返回类型:: 信任

区域操作¶

create_region(**attrs)

从属性创建新区域

参数：: attrs (dict) – 关键字参数，将用于创建 Region，包含 Region 类上的属性。
返回值:: 区域创建的结果。
返回类型:: 区域

delete_region(region, ignore_missing=True)

删除区域

参数：

region – 该值可以是区域的 ID 或一个 Region 实例。
ignore_missing (bool) – 当设置为 False 时，如果区域不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的区域将不会抛出异常。

返回值:

无

find_region(name_or_id, ignore_missing=True)

查找单个区域

参数：

name_or_id – 区域的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果区域不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的区域将返回 None。

返回值:

一个 Region 或 None

get_region(region)

获取单个区域

参数：: region – 该值可以是区域的 ID 或一个 Region 实例。
返回值:: 一个 Region
引发:: NotFoundException 当找不到匹配的区域时。

regions(**query)

检索区域生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的区域。
返回值:: 区域实例的生成器。
返回类型:: 区域

update_region(region, **attrs)

更新区域

参数：

region – 区域的 ID 或一个 Region 实例。
attrs – 要更新由 region 表示的区域的属性。

返回值:

更新后的区域。

返回类型:

区域

角色操作¶

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, **query)

查找单个角色

参数：

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) – 可选的查询参数，用于限制返回的资源。选项为：domain_id、name。
返回值:: 角色实例的生成器。
返回类型:: 角色

update_role(role, **attrs)

更新角色

参数：

role – 区域的 ID 或一个 Role 实例。
kwargs (dict) – 要更新由 value 表示的角色的属性。只能更新名称

返回值:

更新后的角色。

返回类型:

角色

角色分配操作¶

role_assignments_filter(domain=None, project=None, system=None, group=None, user=None)

检索分配给用户/组的角色生成器

参数：

domain – 域的 ID 或 Domain 实例。
project – 项目 ID 或 Project 实例。
system – 系统名称或一个 System 实例。
group – group 的 ID 或 Group 实例。
user – 用户 ID 或 User 实例。

返回值:

角色实例的生成器。

返回类型:

角色

role_assignments(**query)

检索角色分配生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。选项为：group_id、role_id、scope_domain_id、scope_project_id、inherited_to、user_id、include_names、include_subtree。
返回值:: RoleAssignment

assign_domain_role_to_user(domain, user, role, *, inherited=False)

将角色分配给域中的用户

参数：

domain – 域的 ID 或 Domain 实例。
user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

unassign_domain_role_from_user(domain, user, role, *, inherited=False)

从域中的用户取消分配角色

参数：

domain – 域的 ID 或 Domain 实例。
user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

validate_user_has_domain_role(domain, user, role, *, inherited=False)

验证用户是否在域中具有角色

参数：

domain – 域的 ID 或 Domain 实例。
user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。

返回值:

如果用户在域中具有角色，则为 True

assign_domain_role_to_group(domain, group, role, *, inherited=False)

将角色分配给域中的组

参数：

domain – 域的 ID 或 Domain 实例。
group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

unassign_domain_role_from_group(domain, group, role, *, inherited=False)

从域中的组取消分配角色

参数：

domain – 域的 ID 或 Domain 实例。
group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

validate_group_has_domain_role(domain, group, role, *, inherited=False)

验证组是否在域中具有角色

参数：

domain – 域的 ID 或 Domain 实例。
group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。

返回值:

如果组在域中具有角色，则为 True

assign_project_role_to_user(project, user, role, *, inherited=False)

将角色分配给项目中的用户

参数：

project – 项目 ID 或 Project 实例。
user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

unassign_project_role_from_user(project, user, role, *, inherited=False)

从项目中移除用户的角色

参数：

project – 项目 ID 或 Project 实例。
user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

validate_user_has_project_role(project, user, role, *, inherited=False)

验证用户在项目中的角色

参数：

project – 项目 ID 或 Project 实例。
user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。

返回值:

如果用户在项目中拥有角色，则返回 True

assign_project_role_to_group(project, group, role, *, inherited=False)

将角色分配给项目中的组

参数：

project – 项目 ID 或 Project 实例。
group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

unassign_project_role_from_group(project, group, role, *, inherited=False)

从项目中移除组的角色

参数：

project – 项目 ID 或 Project 实例。
group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。
inherited (bool) – 角色分配是否继承。

返回值:

无

validate_group_has_project_role(project, group, role, *, inherited=False)

验证组在项目中的角色

参数：

project – 项目 ID 或 Project 实例。
group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。

返回值:

如果组在项目中拥有角色，则返回 True

assign_system_role_to_user(user, role, system)

将角色分配给系统中的用户

参数：

user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。
system – 系统名称

返回值:

无

unassign_system_role_from_user(user, role, system)

从系统中移除用户的角色

参数：

user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。
system – 系统名称

返回值:

无

validate_user_has_system_role(user, role, system)

验证用户在系统中的角色

参数：

user – 用户 ID 或 User 实例。
role – 区域的 ID 或一个 Role 实例。
system – 系统名称

返回值:

如果用户在系统中拥有角色，则返回 True

assign_system_role_to_group(group, role, system)

将角色分配给系统中的组

参数：

group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。
system – 系统名称

返回值:

无

unassign_system_role_from_group(group, role, system)

从系统中移除组的角色

参数：

group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。
system – 系统名称

返回值:

无

validate_group_has_system_role(group, role, system)

验证组在系统中的角色

参数：

group – group 的 ID 或 Group 实例。
role – 区域的 ID 或一个 Role 实例。
system – 系统名称

返回值:

如果组在系统中拥有角色，则返回 True

已注册的限制操作¶

registered_limits(**query)

检索已注册限制的生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的已注册限制。
返回值:: 已注册限制实例的生成器。
返回类型:: RegisteredLimit

get_registered_limit(registered_limit)

获取单个已注册限制

参数：: registered_limit – 该值可以是已注册限制的 ID，也可以是 RegisteredLimit 实例。
返回值:: 一个 RegisteredLimit
引发:: NotFoundException，当找不到资源时。

create_registered_limit(**attrs)

从属性创建新的已注册限制

参数：: attrs (dict) – 关键字参数，将用于创建 RegisteredLimit，包含 RegisteredLimit 类上的属性。
返回值:: 已注册限制创建的结果。
返回类型:: RegisteredLimit

update_registered_limit(registered_limit, **attrs)

更新已注册限制

参数：

registered_limit – 可以是已注册限制的 ID，也可以是 RegisteredLimit 实例。
kwargs (dict) – 要更新由 value 表示的已注册限制的属性。

返回值:

更新后的已注册限制。

返回类型:

RegisteredLimit

delete_registered_limit(registered_limit, ignore_missing=True)

删除已注册限制

参数：

registered_limit – 该值可以是已注册限制的 ID，也可以是 RegisteredLimit 实例。
ignore_missing (bool) – 当设置为 False 时，如果已注册限制不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的已注册限制时不会引发异常。

返回值:

无

限制操作¶

limits(**query)

检索限制的生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的限制。
返回值:: 限制实例的生成器。
返回类型:: 限制

get_limit(limit)

获取单个限制

参数：: limit – 该值可以是限制的 ID，也可以是 Limit 实例。
返回值:: 一个 Limit
引发:: NotFoundException，当找不到资源时。

create_limit(**attrs)

从属性创建新的限制

参数：: attrs (dict) – 关键字参数，将用于创建 Limit，包含 Limit 类上的属性。
返回值:: 限制创建的结果。
返回类型:: 限制

update_limit(limit, **attrs)

更新限制

参数：

limit – 可以是限制的 ID，也可以是 Limit 实例。
kwargs (dict) – 要更新由 value 表示的限制的属性。

返回值:

更新后的限制。

返回类型:

限制

delete_limit(limit, ignore_missing=True)

删除限制

参数：

limit – 该值可以是限制的 ID，也可以是 Limit 实例。
ignore_missing (bool) – 当设置为 False 时，如果限制不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的限制时不会引发异常。

返回值:

无

应用程序凭证操作¶

application_credentials(user, **query)

检索应用程序凭证的生成器

参数：

user – 用户 ID 或 User 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

应用程序凭证实例的生成器。

返回类型:

ApplicationCredential

get_application_credential(user, application_credential)

获取单个应用程序凭证

参数：

user – 用户 ID 或 User 实例。
application_credential – 该值可以是应用程序凭证的 ID，也可以是 ApplicationCredential 实例。

返回值:

一个 ApplicationCredential

引发:

NotFoundException，当找不到资源时。

create_application_credential(user, name, **attrs)

从属性创建新的应用程序凭证

参数：

user – 用户 ID 或 User 实例。
name – 应用程序凭证的名称，该名称对用户而言是唯一的。
attrs (dict) – 关键字参数，将用于创建 ApplicationCredential，包含 ApplicationCredential 类上的属性。

返回值:

应用程序凭证创建的结果。

返回类型:

ApplicationCredential

find_application_credential(user, name_or_id, ignore_missing=True, **query)

查找单个应用程序凭证

参数：

user – 用户 ID 或 User 实例。
name_or_id – 应用程序凭证的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个 ApplicationCredential 或 None

delete_application_credential(user, application_credential, ignore_missing=True)

删除应用程序凭证

参数：

user – 用户 ID 或 User 实例。
credential (application) – 该值可以是应用程序凭证的 ID，也可以是 ApplicationCredential 实例。
ignore_missing (bool) – 如果设置为 False，当应用程序凭据不存在时，将引发 NotFoundException。如果设置为 True，则尝试删除不存在的应用程序凭据时不会抛出异常。

返回值:

无

联合协议操作¶

create_federation_protocol(idp_id, **attrs)

从属性创建新的联合协议

参数：

idp_id – 身份提供商的 ID，或者表示要附加协议的身份提供商的 IdentityProvider。
attrs (dict) – 用于创建 FederationProtocol 的关键字参数，包含 FederationProtocol 类上的属性。

返回值:

联合协议创建的结果

返回类型:

FederationProtocol

delete_federation_protocol(idp_id, protocol, ignore_missing=True)

删除联合协议

参数：

idp_id – 身份提供商的 ID，或者表示协议附加到的身份提供商的 IdentityProvider。如果协议是 FederationProtocol 实例，则可以为 None。
protocol – 联合协议的 ID，或者 FederationProtocol 实例。
ignore_missing (bool) – 如果设置为 False，当联合协议不存在时，将引发 NotFoundException。如果设置为 True，则尝试删除不存在的联合协议时不会设置异常。

返回值:

无

find_federation_protocol(idp_id, protocol, ignore_missing=True)

查找单个联合协议

参数：

idp_id – 身份提供商的 ID，或者表示协议附加到的身份提供商的 IdentityProvider。
protocol – 联合协议的名称或 ID。
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

一个联合协议或 None

返回类型:

FederationProtocol

get_federation_protocol(idp_id, protocol)

获取单个联合协议

参数：

idp_id – 身份提供商的 ID，或者表示协议附加到的身份提供商的 IdentityProvider。如果协议是 FederationProtocol 实例，则可以为 None。
protocol – 该值可以是联合协议的 ID，或者 FederationProtocol 实例。

返回值:

一个联合协议

返回类型:

FederationProtocol

引发:

NotFoundException，当找不到资源时。

federation_protocols(idp_id, **query)

检索联合协议生成器

参数：

idp_id – 身份提供商的 ID，或者表示协议附加到的身份提供商的 IdentityProvider。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

联合协议实例的生成器。

返回类型:

FederationProtocol

update_federation_protocol(idp_id, protocol, **attrs)

更新联合协议

参数：

idp_id – 身份提供商的 ID，或者表示协议附加到的身份提供商的 IdentityProvider。如果协议是 FederationProtocol 实例，则可以为 None。
protocol – 联合协议的 ID，或者 FederationProtocol 实例。
attrs – 要更新由 protocol 表示的联合协议上的属性。

返回值:

更新后的联合协议

返回类型:

FederationProtocol

映射操作¶

create_mapping(**attrs)

从属性创建新的映射

参数：: attrs (dict) – 用于创建 Mapping 的关键字参数，包含 Mapping 类上的属性。
返回值:: 映射创建的结果
返回类型:: Mapping

delete_mapping(mapping, ignore_missing=True)

删除映射

参数：

mapping – 映射的 ID，或者 Mapping 实例。
ignore_missing (bool) – 如果设置为 False，当映射不存在时，将引发 NotFoundException。如果设置为 True，则尝试删除不存在的映射时不会设置异常。

返回值:

无

find_mapping(name_or_id, ignore_missing=True)

查找单个映射

参数：

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

返回值:

一个 Mapping 或 None

get_mapping(mapping)

获取单个映射

参数：: mapping – 该值可以是映射的 ID，或者 Mapping 实例。
返回值:: 一个 Mapping
引发:: NotFoundException，当找不到资源时。

mappings(**query)

检索映射生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 映射实例的生成器。
返回类型:: Mapping

update_mapping(mapping, **attrs)

更新映射

参数：

mapping – 映射的 ID，或者 Mapping 实例。
attrs – 要更新由 mapping 表示的映射上的属性。

返回值:

更新后的映射

返回类型:

Mapping

身份提供商操作¶

create_identity_provider(**attrs)

从属性创建新的身份提供商

参数：: attrs (dict) – 用于创建 IdentityProvider 的关键字参数，包含 IdentityProvider 类上的属性。
返回值:: 身份提供商创建的结果
返回类型:: IdentityProvider

delete_identity_provider(identity_provider, ignore_missing=True)

删除身份提供商

参数：

mapping – 身份提供商的 ID，或者 IdentityProvider 实例。
ignore_missing (bool) – 如果设置为 False，当身份提供商不存在时，将引发 NotFoundException。如果设置为 True，则尝试删除不存在的身份提供商时不会设置异常。

返回值:

无

find_identity_provider(name_or_id, ignore_missing=True)

查找单个身份提供商

参数：

name_or_id – 身份提供商的名称或 ID
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

身份提供商的详细信息或 None。

返回类型:

IdentityProvider

get_identity_provider(identity_provider)

获取单个映射

参数：: mapping – 该值可以是身份提供商的 ID，或者 IdentityProvider 实例。
返回值:: 身份提供商的详细信息。
返回类型:: IdentityProvider
引发:: NotFoundException，当找不到资源时。

identity_providers(**query)

检索身份提供商生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 身份提供商实例的生成器。
返回类型:: IdentityProvider

update_identity_provider(identity_provider, **attrs)

更新映射

参数：

mapping – 要么是身份提供程序的 ID，要么是一个 IdentityProvider 实例。
attrs – 要更新的由 identity_provider 表示的身份提供程序的属性。

返回值:

更新后的身份提供程序。

返回类型:

IdentityProvider

访问规则操作¶

access_rules(user, **query)

检索访问规则的生成器

参数：

user – 用户 ID 或 User 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

访问规则实例的生成器。

返回类型:

AccessRule

access_rules(user, **query)

检索访问规则的生成器

参数：

user – 用户 ID 或 User 实例。
query (kwargs) – 可选的查询参数，用于限制返回的资源。

返回值:

访问规则实例的生成器。

返回类型:

AccessRule

delete_access_rule(user, access_rule, ignore_missing=True)

删除访问规则

参数：

user – 用户 ID 或 User 实例。
rule (access) – 该值可以是访问规则的 ID 或 AccessRule 实例。
ignore_missing (bool) – 当设置为 False 时，如果访问规则不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的访问规则时不会抛出异常。

返回值:

无

服务提供程序操作¶

create_service_provider(**attrs)

从属性创建新的服务提供程序

参数：: attrs (dict) – 关键字参数，将用于创建 ServiceProvider，包含 ServiceProvider 类上的属性。
返回值:: 服务提供程序创建的结果
返回类型:: ServiceProvider

delete_service_provider(service_provider, ignore_missing=True)

删除服务提供程序

参数：

service_provider – 服务提供程序的 ID 或 ServiceProvider 实例。
ignore_missing (bool) – 当设置为 False 时，如果服务提供程序不存在，将引发 NotFoundException。当设置为 True 时，尝试删除不存在的服务提供程序时不会设置异常。

返回值:

无

find_service_provider(name_or_id, ignore_missing=True)

查找单个服务提供程序

参数：

name_or_id – 服务提供程序的名称或 ID
ignore_missing (bool) – 当设置为 False 时，如果资源不存在，将引发 NotFoundException。当设置为 True 时，尝试查找不存在的资源时将返回 None。

返回值:

服务提供程序的详细信息或 None。

返回类型:

ServiceProvider

get_service_provider(service_provider)

获取单个服务提供程序

参数：: service_provider – 该值可以是服务提供程序的 ID 或 ServiceProvider 实例。
返回值:: 服务提供程序的详细信息。
返回类型:: ServiceProvider
引发:: NotFoundException，当找不到资源时。

service_providers(**query)

检索服务提供程序的生成器

参数：: query (kwargs) – 可选的查询参数，用于限制返回的资源。
返回值:: 服务提供程序实例的生成器。
返回类型:: ServiceProvider

update_service_provider(service_provider, **attrs)

更新服务提供程序

参数：

service_provider – 要么是服务提供程序的 ID，要么是一个 ServiceProvider 实例。
attrs – 要更新的由 service_provider 表示的服务提供程序的属性。

返回值:

更新后的服务提供程序。

返回类型:

ServiceProvider

Identity API v3

Identity API v3¶

Identity v3 类¶

凭证操作¶

域操作¶

域配置操作¶

Endpoint 操作¶

Group 操作¶

Policy 操作¶

项目操作¶

服务操作¶

用户操作¶

信任操作¶

区域操作¶

角色操作¶

角色分配操作¶

已注册的限制操作¶

限制操作¶

应用程序凭证操作¶

联合协议操作¶

映射操作¶

身份提供商操作¶

访问规则操作¶

服务提供程序操作¶

openstacksdk 4.7.2.dev3

页面内容