BatchAddFeishuUsers - 批量添加飞书用户 - 智能商业分析 Quick BI

批量添加飞书用户。

说明

目前该API接口已标记为弃用。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:BatchAddFeishuUsers

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
IsAuthAdmin	boolean	否	是否是权限管理员 true false 不填写默认为 false	true
IsAdmin	boolean	否	是否为 admin 用户： true false 不填写默认为 false	False
FeishuUsers	string	否	要添加的用户信息	{"ad**fd": "test", "82**5a": "t't"}"
UserGroupIds	string	否	所属用户组	"0d5fb19b-5555-41f0-99da-1248fc27ca51,0f868dd6_68dd_4d13_8422_c5dca3bd4b61"
UserType	integer	否	用户类型开发者类型：1 访问者类型：2 分析师：3	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	object	返回添加用户组成员的结果。取值范围： true：添加成功 false：添加失败	True
FailCount	integer	失败校验的个数。	10
FailResults	array<object>	失败的具体详情。
	array<object>
FailInfos	array<object>	错误原因。
	object
Code	string	错误码。	ACCOUNT_EXIST
CodeDesc	string	错误码描述。	test
Input	string	错误的输入值。	20
OkCount	integer	成功计数。	1
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	True

示例

正常返回示例

JSON格式

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": {
    "FailCount": 10,
    "FailResults": [
      {
        "FailInfos": [
          {
            "Code": "ACCOUNT_EXIST",
            "CodeDesc": "test",
            "Input": "20"
          }
        ]
      }
    ],
    "OkCount": 1
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
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	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用户组中。

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

变更历史

更多信息，参考变更详情。