Call BatchAddFeishuUsers to add multiple Feishu users - Quick BI - Alibaba Cloud - Quick BI

Adds multiple Lark users.

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:BatchAddFeishuUsers

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IsAuthAdmin	boolean	No	Specifies whether the user is a permission management administrator. Valid values: true: Yes. false: No. Default value: false.	true
IsAdmin	boolean	No	Specifies whether the user is an administrator. Valid values: true: Yes. false: No. Default value: false.	False
FeishuUsers	string	No	The information about the users to be added.	{"ad**fd": "test", "82**5a": "t't"}"
UserGroupIds	string	No	The IDs of the user groups to which the users belong.	"0d5fb19b-5555-41f0-99da-1248fc27ca51,0f868dd6_68dd_4d13_8422_c5dca3bd4b61"
UserType	integer	No	The user type. Valid values: 1: Developer. 2: Visitor. 3: Analyst.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	object	Indicates whether the user group members are added. Valid values: true: The user group members are added. false: The user group members fail to be added.	True
FailCount	integer	The number of failures.	10
FailResults	array<object>	The details of the failures.
	array<object>
FailInfos	array<object>	The causes of the errors.
	object
Code	string	The error code.	ACCOUNT_EXIST
CodeDesc	string	The description of the error code.	test
Input	string	The invalid input value.	20
OkCount	integer	The number of successes.	1
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	True

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Feishhu.Config.Not.Exit	Feishu is not configured in the current organization	Lark is not configured for the current organization.
400	Feishu.User.Need.Sync.Contact	Feishu need to sync contact list.	The Lark address book must be synchronized.
400	Feishu.Parameter.Error	Feishu config error: %s.	Invalid Lark parameter: %s.
400	Mail.Invalid	Email/phone number is invalid.	The email address or phone number is invalid.
400	Usergroup.Not.Exist	The user group does 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.	The Lark account already exists or is already bound.
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.	Organization viewer cannot have custom roles.
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	This role has permissions that analysts cannot grant.
400	User.OrganizationRole.NotExist	User %s must have role in organization.	User %s must have role in organization.
400	FeishuUser.UserGroup.AssociationError	Feishu User can only be added into feishu or Bi user group.	Lark users can only be added to Lark or BI user groups.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.