文档首页> 统一身份认证服务 IAM> API参考> API> 委托管理> 修改委托
更新时间：2023-07-18 GMT+08:00
查看PDF

修改委托

功能介绍

该接口可以用于管理员修改委托。

该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。

URI

PUT /v3.0/OS-AGENCY/agencies/{agency_id}

表1 路径参数

参数

是否必选

参数类型

描述

agency_id

是

String

待修改的委托ID，获取方式请参见：获取帐号、IAM用户、项目、用户组、区域、委托的名称和ID。

请求参数

表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

否

String

委托的期限，单位为“天”。四个参数至少填写一个。

取值范围：

  • FOREVER：表示委托的期限为永久。
  • ONEDAY：表示委托的期限为一天。
  • 自定义天数：表示委托的期限为有限天数，如20。

响应参数

表5 响应Body参数

参数

参数类型

描述

agency

object

委托信息。
表6 agency

参数

参数类型

描述

create_time

String

委托创建时间。

说明：

UTC时间，格式为 YYYY-MM-DDTHH:mm:ss.ssssssZ，日期和时间戳格式参照 ISO-8601，如：2023-06-28T08:56:33.710000Z。

description

String

委托描述信息。

domain_id

String

委托方帐号ID。

duration

String

委托的期限，单位为“小时”。

  • FOREVER/null：表示委托的期限为永久。
  • 24：表示委托的期限为一天，即24小时。
  • XXX：表示委托的期限为有限时间，如480小时。

expire_time

String

委托过期时间。“null”表示不过期。

说明：

UTC时间，格式为 YYYY-MM-DDTHH:mm:ss.ssssssZ，日期和时间戳格式参照 ISO-8601，如：2023-06-28T08:56:33.710000Z。

id

String

委托ID。

name

String

委托名。

trust_domain_id

String

被委托方帐号ID。

trust_domain_name

String

被委托方帐号名。

请求示例

修改委托的有效时间为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"
    }
}

响应示例

状态码为 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"
    }
}

返回值

返回值

描述

200

修改成功。

400

参数无效。

401

认证失败。

403

没有操作权限。

404

未找到相应的资源。

500

内部服务错误。

错误码

无

父主题： 委托管理