华为云用户手册

响应参数 表3 响应Body参数 参数 参数类型 描述 identity_provider Object 身份提供商信息。 表4 identity_provider 参数 参数类型 描述 sso_type String 身份提供商类型。当前支持如下两种： virtual_user_sso：联邦登录跳转后映射为虚拟用户。 iam_user_sso：联邦登录跳转后映射为实际存在的 IAM 用户。 默认配置为virtual_user_sso类型。 id String 身份提供商ID。 description String 身份提供商描述信息。 enabled Boolean 身份提供商是否启用，true为启用，false为停用，默认为false。 remote_ids Array of strings 身份提供商的联邦用户ID列表。 links Object 身份提供商的资源链接信息。 表5 identity_provider.links 参数 参数类型 描述 self String 身份提供商的资源链接地址。 protocols String 协议的资源链接地址。

响应示例 状态码为 200 时: 请求成功。 { "identity_provider": { "remote_ids": [], "enabled": true, "id": "ACME", "sso_type": "iam_user_sso", "links": { "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME", "protocols": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols" }, "description": "Stores ACME identities." } }

响应参数 表2 响应Body参数 参数 参数类型 描述 identity_providers Array of objects 身份提供商信息列表。 links Object 资源链接信息。 表3 identity_providers 参数 参数类型 描述 sso_type String 身份提供商类型。当前支持如下两种： virtual_user_sso：联邦登录跳转后映射为虚拟用户。 iam_user_sso：联邦登录跳转后映射为实际存在的IAM用户。 默认配置为virtual_user_sso类型。 id String 身份提供商ID。 description String 身份提供商描述信息。 enabled Boolean 身份提供商是否启用，true为启用，false为停用，默认为false。 remote_ids Array of strings 身份提供商的联邦用户ID列表。 links Object 身份提供商的资源链接信息。 表4 identity_providers.links 参数 参数类型 描述 self String 身份提供商的资源链接地址。 protocols String 协议的资源链接地址。 表5 links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址，不存在时为null。 next String 后一邻接资源链接地址，不存在时为null。

响应示例 状态码为 200 时: 请求成功。 { "links": { "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers", "previous": null, "next": null }, "identity_providers": [ { "remote_ids": [], "enabled": true, "id": "ACME", "sso_type": "iam_user_sso", "links": { "self": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME", "protocols": "https://iam.myhuaweicloud.com/v3/OS-FEDERATION/identity_providers/ACME/protocols" }, "description": "Stores ACME identities." } ] }

URI DELETE /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/roles/{role_id}/inherited_to_projects 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方的账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 权限ID，获取方式请参见：获取权限ID。

URI HEAD /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/roles/{role_id}/inherited_to_projects 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方的账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 权限ID，获取方式请参见：获取权限ID。

URI PUT /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/roles/{role_id}/inherited_to_projects 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方的账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 权限ID，获取方式请参见：获取权限ID。

响应示例 状态码为 200 时: 查询成功 { "roles" : [ { "name" : "system_all_154", "links" : { "self" : "https://internal.iam.ctcclouddev.com/v3/roles/04570dfe267c45a3940e1ae9de868..." }, "id" : "04570dfe267c45a3940e1ae9de868..." }, { "name" : "test1_admin", "links" : { "self" : "https://internal.iam.ctcclouddev.com/v3/roles/1bf20f1adba94747a6e02e1be3810..." }, "id" : "1bf20f1adba94747a6e02e1be3810..." } ], "links" : { "self" : "https://internal.iam.ctcclouddev.com/v3.0/OSHERIT/domains/05b09b4723001dc90f27c0008f8b1.../agencies/08c6652e86801d234f01c00078308.../roles/inherited_to_projects" } }

URI GET /v3.0/OS-INHERIT/domains/{domain_id}/agencies/{agency_id}/roles/inherited_to_projects 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

URI DELETE /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 project_id 是 String 委托方的项目ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 项目服务权限ID，获取方式请参见：获取权限ID。

URI DELETE /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 全局服务权限ID，获取方式请参见：获取权限ID。

URI HEAD /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 project_id 是 String 委托方的项目ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 项目服务权限ID，获取方式请参见：获取权限ID。

URI HEAD /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 全局服务权限ID。获取方式请参见：获取权限ID。

URI PUT /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 project_id 是 String 委托方的项目ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 项目服务权限ID，获取方式请参见：获取权限ID。

URI PUT /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 role_id 是 String 全局服务权限ID，获取方式请参见：获取权限ID。

URI GET /v3.0/OS-AGENCY/projects/{project_id}/agencies/{agency_id}/roles 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 project_id 是 String 委托方的项目ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

响应示例 状态码为 200 时: 请求成功。 { "roles": [ { "domain_id": null, "flag": "fine_grained", "description_cn": " 应用运维管理 服务只读权限", "catalog": " AOM ", "name": "system_all_30", "description": "AOM read only", "id": "75cfe22af2b3498d82b655fbb39de498", "display_name": "AOM Viewer", "type": "XA", "policy": { "Version": "1.1", "Statement": [ { "Action": [ "aom:*:list", "aom:*:get", "apm:*:list", "apm:*:get" ], "Effect": "Allow" } ] } } ] }

URI GET /v3.0/OS-AGENCY/domains/{domain_id}/agencies/{agency_id}/roles 表1 路径参数 参数 是否必选 参数类型 描述 agency_id 是 String 委托ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 domain_id 是 String 委托方账号ID，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。

响应示例 状态码为 200 时: 请求成功。 { "roles": [ { "flag": "fine_grained", "display_name": "CDN Domain Viewer", "description": "Allow Query Domains", "name": "system_all_11", "policy": { "Version": "1.1", "Statement": [ { "Action": [ "cdn:configuration:queryDomains", "cdn:configuration:queryOriginServerInfo", "cdn:configuration:queryOriginConfInfo", "cdn:configuration:queryHttpsConf", "cdn:configuration:queryCacheRule", "cdn:configuration:queryReferConf", "cdn:configuration:queryChargeMode", "cdn:configuration:queryCacheHistoryTask", "cdn:configuration:queryIpAcl", "cdn:configuration:queryResponseHeaderList" ], "Effect": "Allow" } ] }, "description_cn": "查询 域名 信息", "domain_id": null, "type": "AX", "catalog": "CDN", "id": "db4259cce0ce47c9903dfdc195eb453b" } ] }

响应示例 状态码为 200 时: 修改成功。 { "agency": { "description": "IAMDescription", "trust_domain_id": "b2cd82a33fb043dc9304bf72a0...", "id": "0760a9e2a60026664f1fc0031f9f205e", "duration": "ONEDAY", "create_time": "2020-01-04T03:37:16.000000", "expire_time": "2020-01-21T13:06:11.241588", "domain_id": "d78cbac186b744899480f25...", "name": "IAMAgency" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌，承载用户的身份、权限等信息。 token所需权限请参见授权项。 表3 请求Body参数 参数 是否必选 参数类型 描述 agency 是 object 委托信息。 表4 agency 参数 是否必选 参数类型 描述 trust_domain_id 否 String 被委托方账号ID。如果trust_domain_id和trust_domain_name都填写，则优先校验trust_domain_name。四个参数至少填写一个。 trust_domain_name 否 String 被委托方账号名。如果trust_domain_id和trust_domain_name都填写，则优先校验trust_domain_name。四个参数至少填写一个。 description 否 String 委托描述信息，长度不大于255位。四个参数至少填写一个。 duration 否 object 委托的期限，单位为“天”。四个参数至少填写一个。 取值范围： FOREVER：表示委托的期限为永久。 ONEDAY：表示委托的期限为一天。 自定义天数：表示委托的期限为有限天数，如20。

请求示例 修改委托的有效时间为1天。 PUT https://iam.myhuaweicloud.com/v3.0/OS-AGENCY/agencies/{agency_id} { "agency": { "trust_domain_id": "b2cd82a33fb043dc9304bf72...", "trust_domain_name": "IAMDomainB", "description": "IAMDescription", "duration": "ONEDAY" } }

响应参数 表5 响应Body参数 参数 参数类型 描述 agency object 委托信息。 表6 agency 参数 参数类型 描述 create_time String 委托创建时间。 说明： UTC时间，格式为YYYY-MM-DDTHH:mm:ss.ssssss，日期和时间戳格式如：2023-06-28T08:56:33.710000。 description String 委托描述信息。 domain_id String 委托方账号ID。 duration String 委托的期限，单位为“小时”。 FOREVER/null：表示委托的期限为永久。 24：表示委托的期限为一天，即24小时。 XXX：表示委托的期限为有限时间，如480小时。 expire_time String 委托过期时间。“null”表示不过期。 说明： UTC时间，格式为YYYY-MM-DDTHH:mm:ss.ssssss，日期和时间戳格式如：2023-06-28T08:56:33.710000。 id String 委托ID。 name String 委托名。 trust_domain_id String 被委托方账号ID。

响应示例 状态码为 201 时: 创建成功。 { "agency": { "description": "IAMDescription", "trust_domain_id": "a2cd82a33fb043dc9304bf72a0f...", "id": "078ade0fc20010004f8fc0034fad529d", "duration": "FOREVER", "create_time": "2020-01-20T12:59:20.811642", "expire_time": null, "domain_id": "d78cbac186b744899480f25bd02...", "name": "IAMAgency" } }

响应参数 表4 响应Body参数 参数 参数类型 描述 agency object 委托信息。 表5 agency 参数 参数类型 描述 create_time String 委托创建时间。 说明： UTC时间，格式为YYYY-MM-DDTHH:mm:ss.ssssss，日期和时间戳格式如：2023-06-28T08:56:33.710000。 description String 委托描述信息。 domain_id String 委托方账号ID。 duration String 委托的期限，单位为“小时”。 FOREVER/null：表示委托的期限为永久。 24：表示委托的期限为一天，即24小时。 XXX：表示委托的期限为有限时间，如480小时。 expire_time String 委托过期时间。“null”表示不过期。 说明： UTC时间，格式为YYYY-MM-DDTHH:mm:ss.ssssss，日期和时间戳格式如：2023-06-28T08:56:33.710000。 id String 委托ID。 name String 委托名。 trust_domain_id String 被委托方账号ID。

请求示例 创建一个名为“IAMAgency”的委托，被委托账号ID是c2cd82a33fb043dc9304bf72a...，账号名是IAMDomainB，委托的有效期限是永久。 POST https://iam.myhuaweicloud.com/v3.0/OS-AGENCY/agencies { "agency": { "name": "IAMAgency", "domain_id": "d78cbac186b744899480f25bd...", "trust_domain_id": "c2cd82a33fb043dc9304bf72a...", "trust_domain_name": "IAMDomainB", "duration": "FOREVER", "description": "IAMDescription" } }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。 X-Auth-Token 是 String 访问令牌，承载用户的身份、权限等信息。 token所需权限请参见授权项。 表2 请求Body参数 参数 是否必选 参数类型 描述 agency 是 object 委托信息。 表3 agency 参数 是否必选 参数类型 描述 name 是 String 委托名，长度不大于64位。 domain_id 是 String 委托方账号ID。 trust_domain_id 否 String 被委托方账号ID。trust_domain_id和trust_domain_name至少填写一个，若都填写优先校验trust_domain_name。 trust_domain_name 否 String 被委托方账号名。trust_domain_id和trust_domain_name至少填写一个，若都填写优先校验trust_domain_name。 description 否 String 委托描述信息，长度不大于255位。 duration 否 object 委托的期限，单位为“天”。默认为FOREVER。 取值范围： FOREVER：表示委托的期限为永久。 ONEDAY：表示委托的期限为一天。 自定义天数：表示委托的期限为有限天数，如20。

响应示例 状态码为 200 时: 请求成功。 { "agency":{ "create_time":"2020-01-04T03:37:16.000000", "description":"", "domain_id":"d78cbac186b744899480f25bd...8", "duration":"FOREVER", "id":"0760a9e2a60026664f1fc0031f9f205e", "name":"IAMAgency", "agency_urn": "iam::d78cbac186b744899480f25b...8:agency:IAMAgency", "trust_domain_id":"a2cd82a33fb043dc9304bf72...", "trust_domain_name":"IAMDomainB" } }

响应参数 表3 响应Body参数 参数 参数类型 描述 agency object 委托信息。 表4 agency 参数 参数类型 描述 create_time String 委托创建时间。 说明： UTC时间，格式为YYYY-MM-DDTHH:mm:ss.ssssss，日期和时间戳格式如：2023-06-28T08:56:33.710000。 description String 委托描述信息。 domain_id String 委托方账号ID。 duration String 委托的期限，单位为“小时”。 FOREVER/null：表示委托的期限为永久。 24：表示委托的期限为一天，即24小时。 XXX：表示委托的期限为有限时间，如480小时。 expire_time String 委托过期时间。“null”表示不过期。 说明： UTC时间，格式为YYYY-MM-DDTHH:mm:ss.ssssss，日期和时间戳格式如：2023-06-28T08:56:33.710000。 id String 委托ID。 name String 委托名。 agency_urn String 委托URN。 trust_domain_id String 被委托方账号ID。 trust_domain_name String 被委托方账号名。

响应示例 状态码为 200 时: 请求成功。 { "agencies": [ { "create_time": "2020-01-04T03:37:16.000000", "description": "", "domain_id": "d78cbac186b744899480f25b...8", "duration": "FOREVER", "expire_time": null, "id": "0760a9e2a60026664f1fc0031f9f2...", "name": "IAMAgency", "agency_urn": "iam::d78cbac186b744899480f25b...8:agency:IAMAgency", "trust_domain_id": "a2cd82a33fb043dc9304bf72...", "trust_domain_name": "IAMDomainB" } ] }