批量删除用户

最近更新时间:2024-08-12 02:09:57

我的收藏

1. 接口描述

接口请求域名: smh.tencentcloudapi.com 。

一次删除多个用户。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DeleteUser。
Version String 公共参数,本接口取值:2021-07-12。
Region String 公共参数,本接口不需要传递此参数。
LibraryId String 媒体库 ID。
示例值:smh08gcw6500e6jl
Filters.N Array of UserFilter 用于唯一查找用户的过滤器数组,数组之间为 的关系,即满足任意一个过滤器的用户,都将被删除,单次传入的过滤器最多为 100 个。
示例值:[ { "Key": "PhoneNumber", "Value": "+86-13800000000" }, { "Key": "Email", "Value": "admin@mail.foobar.com" } ]

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 删除多个用户

输入示例

POST / HTTP/1.1
Host: smh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteUser
<公共请求参数>

{
    "LibraryId": "smh08gcw6500e6jl",
    "Filters": [
        {
            "Key": "PhoneNumber",
            "Value": "+86-13800000000"
        },
        {
            "Key": "Email",
            "Value": "admin@mail.foobar.com"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameterValue.Filter 指定的 Filter 无效。
InvalidParameterValue.TooManyFilters 指定了太多的过滤器,过滤器最多为 100 个。
ResourceNotFound.Library 媒体库不存在或不属于当前账号。