批量添加飞书用户。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| IsAuthAdmin | boolean | 否 | 是否是权限管理员
不填写默认为 false | true |
| IsAdmin | boolean | 否 | 是否为 admin 用户：
不填写默认为 false | False |
| FeishuUsers | string | 否 | 要添加的用户信息 | {"ad****fd": "张三", "82****5a": "李四"}" |
| UserGroupIds | string | 否 | 所属用户组 | "0d5fb19b-5555-41f0-99da-1248fc27ca51,0f868dd6_68dd_4d13_8422_c5dca3bd4b61" |
| UserType | integer | 否 | 用户类型
| 1 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
"Result": {
"OkCount": 1,
"FailCount": 10,
"FailResults": [
{
"FailInfos": [
{
"Code": "ACCOUNT_EXIST",
"Input": "20",
"CodeDesc": "账号已存在"
}
]
}
]
},
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
| 400 | Feishhu.Config.Not.Exit | Feishu is not configured in the current organization | 当前组织未配置飞书。 |
| 400 | Feishu.User.Need.Sync.Contact | Feishu need to sync contact list. | 飞书需要同步通讯录。 |
| 400 | Feishu.Parameter.Error | Feishu config error: %s. | 飞书参数错误：%s。 |
| 400 | Mail.Invalid | Email/phone number is invalid. | 邮箱/手机号无效。 |
| 400 | Usergroup.Not.Exist | The user group does not exist. | 用户组不存在。 |
| 400 | Instance.Over.MaxLicense | You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first. | 您可以添加的用户已达上限，请升级配置或移除其它用户后再添加。 |
| 400 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
| 400 | Feishu.User.Duplicated | Feishu account already exists or bound：%s. | 飞书账号已存在或绑定。 |
| 400 | Viewer.CannotHave.CustomRole | Organization viewer cannot have custom roles. | 组织访问者不能具有自定义角色。 |
| 400 | UserAnalyst.NotSupport.ThisRole | This role has permissions that analysts cannot grant. | 该角色具有分析员无法授予的权限。 |
| 400 | User.OrganizationRole.NotExist | User %s must have role in organization. | 用户 %s 在组织中必须有一个角色。 |
| 400 | FeishuUser.UserGroup.AssociationError | Feishu User can only be added into feishu or Bi user group. | 飞书用户只能被添加到飞书或BI用户组中。 |
| 400 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
| 400 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
| 400 | User.Not.In.Organization | The specified user is not in the organizational unit. | 该用户不在组织中。 |
| 400 | Invalid.Parameter | An error occurred while verifying parameters. | 参数验证失败。 |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
| 400 | Invalid.User.Admin | You are not an administrator of this organization. | 没有权限，您不是组织管理员。 |
| 400 | System.Param.Empty | You must specify the %s parameter. | 参数%s不能为空。 |
| 400 | Access.Forbidden | Your instance version or access key is not allowed to call the API operation, only professional version supports calling. | 您的实例版本或者 AccessKey不允许调用该 API，仅专业版支持调用。 |
| 400 | UserInfo.Error | The personal information is invalid. | 个人信息不合法。 |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | 用户不存在。 |
| 400 | User.Not.WorkspaceAdmin | Only administrators of the group workspace can perform this operation. | 没有权限，您不是该群空间的管理员。 |
| 400 | Application.Object.NotExist | The object you are operating does not exist or has been deleted. | 操作组件不存在或已被删除。 |
| 400 | Not.ApiCall.AuthUser | You are not an administrator or API call auth user of this organization. | 非组织管理员或API调用授权用户。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||
|---|---|---|---|---|---|---|
| 2023-10-24 | OpenAPI 错误码发生变更 | 看变更集 | ||||
| ||||||
| 2023-08-07 | OpenAPI 错误码发生变更 | 看变更集 | ||||
| ||||||
| 2022-09-08 | 新增 OpenAPI | 看变更集 |