Skip to content

重置用户的企业邮箱密码

重置用户的企业邮箱密码,仅当用户的邮箱和企业邮箱(别名)一致时生效,可用于处理飞书企业邮箱登录死锁的问题。

邮箱死锁:当用户的登录凭证与飞书企业邮箱一致时,目前飞书登录流程要求用户输入验证码,由于飞书邮箱无单独的帐号体系,则未登录时无法收取邮箱验证码,即陷入死锁。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/admin/v1/password/reset
HTTP MethodPOST
接口频率限制10 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用admin:ent_email_password 修改企业邮箱的密码
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:"open_id"
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
passwordpassword需要重置的密码参数,不少于8个字符,字母、数字和符号,至少三选二
示例值:1234abcd
  └ ent_email_passwordstring企业邮箱密码
示例值:"abcd*efg"
user_idstring待修改密码的用户ID,只针对邮箱登录凭证与企业邮箱(包括别名)相等的用户生效
示例值:"abc123"
数据校验规则
- 长度范围:0200 字符

请求体示例

json
{
    "password": {
        "ent_email_password": "abcd*efg"
    },
    "user_id": "abc123"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码错误码描述排查建议
4001050023reach reset password num limit请次日再进行尝试
4001050022password format is not valid请修改密码格式后再尝试
4001050024user cant reset password.may be user enterprise email not equal email只能修改用户邮箱和企业邮箱(别名)一致的用户密码

内容来源:飞书开放平台 · 自动爬取整理