更新子账号信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

更新子账号信息

最近更新时间：2024.11.27 10:47:15首次发布时间：2024.11.27 10:47:15

调用 UpdateSubAccount 接口，更新指定子账号的昵称、组织或角色。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateSubAccount&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateSubAccount`	接口名称。当前 API 的名称为 `UpdateSubAccount`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
Name	String	是	`on_2222222222222`	子账号的账号，是子账号的唯一标识。您可通过调用 ListSubAccounts 接口获取账号。
NickName	String	否	`小明`	子账号的昵称。长度为 1 到 16 个字符。支持以下字符：大写字母 A - Z 小写字母 a - z 数字中文昵称更新后，IAM 用户的昵称（显示名）也会同步更新。
OrganizationId	Long	否	`184****1234`	子账号所属组织的 ID。您可通过调用 ListSubAccountOrganizations 接口获取 ID。
RoleIds	Array of Long	否	`[187**1234,186**5678]`	子账号所属角色的 ID。如传入空数组，则自动更新为默认子账号角色。您可通过调用 ListSubAccountRoles 接口获取 ID。对于飞书成员类型（`Type` 取值为 `3`）的子账号而言，如果参数值不包含默认子账号角色，则会自动添加默认子账号角色。说明每个子账号最多可被赋予 100 个角色。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	子账号信息是否更新成功。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateSubAccount&Version=2023-08-01
{
    "NickName": "小明",
    "OrganizationId": 184****1234,
    "RoleIds": [
        187****1234,186****5678
    ],
    "Name": "on_2222222222222"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateSubAccount",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

访问公共错误码和错误码获取详细信息。