文档

BatchAddFeishuUsers - 批量添加飞书用户

更新时间:

批量添加飞书用户。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
IsAuthAdminboolean

是否是权限管理员

  • true
  • false

不填写默认为 false

true
IsAdminboolean

是否为 admin 用户:

  • true
  • false

不填写默认为 false

False
FeishuUsersstring

要添加的用户信息

{"ad****fd": "张三", "82****5a": "李四"}"
UserGroupIdsstring

所属用户组

"0d5fb19b-5555-41f0-99da-1248fc27ca51,0f868dd6_68dd_4d13_8422_c5dca3bd4b61"
UserTypeinteger

用户类型

  • 开发者类型:1
  • 访问者类型:2
  • 分析师:3
1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Resultobject

返回添加用户组成员的结果。取值范围:

  • true:添加成功

  • false:添加失败

OkCountinteger

成功计数。

1
FailCountinteger

失败校验的个数。

10
FailResultsobject []

失败的具体详情。

FailInfosobject []

错误原因。

Codestring

错误码。

ACCOUNT_EXIST
Inputstring

错误的输入值。

20
CodeDescstring

错误码描述。

账号已存在
Successboolean

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败
True

示例

正常返回示例

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错误码错误信息描述
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Feishhu.Config.Not.ExitFeishu is not configured in the current organization当前组织未配置飞书。
400Feishu.User.Need.Sync.ContactFeishu need to sync contact list.飞书需要同步通讯录。
400Feishu.Parameter.ErrorFeishu config error: %s.飞书参数错误:%s。
400Mail.InvalidEmail/phone number is invalid.邮箱/手机号无效。
400Usergroup.Not.ExistThe user group does not exist.用户组不存在。
400Instance.Over.MaxLicenseYou have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.您可以添加的用户已达上限,请升级配置或移除其它用户后再添加。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Feishu.User.DuplicatedFeishu account already exists or bound:%s.飞书账号已存在或绑定。
400Viewer.CannotHave.CustomRoleOrganization viewer cannot have custom roles.组织访问者不能具有自定义角色。
400UserAnalyst.NotSupport.ThisRoleThis role has permissions that analysts cannot grant.该角色具有分析员无法授予的权限。
400User.OrganizationRole.NotExistUser %s must have role in organization.用户 %s 在组织中必须有一个角色。
400FeishuUser.UserGroup.AssociationErrorFeishu User can only be added into feishu or Bi user group.飞书用户只能被添加到飞书或BI用户组中。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-24OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-08-07OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-09-08新增 OpenAPI看变更集