All Products
Search
Document Center

Quick BI:BatchAddFeishuUsers

Last Updated:Nov 04, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.
无替代API,历史原因导致该API被标记为弃用。

Batch add Feishu users.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:BatchAddFeishuUserscreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IsAuthAdminbooleanNo

Whether the user is an authorization administrator

  • true
  • false

Default is false if not provided

true
IsAdminbooleanNo

Whether the user is an admin user:

  • true
  • false

Default is false if not provided

False
FeishuUsersstringNo

Information of the users to be added

{"ad****fd": "TEST", "82****5a": "TEST"}"
UserGroupIdsstringNo

User group ID(s)

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

User type

  • Developer: 1
  • Visitor: 2
  • Analyst: 3
1

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

Request ID.

D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Resultobject

Result of adding members to the user group. Possible values:

  • true: Addition successful
  • false: Addition failed
FailCountinteger

Number of failed validations.

10
FailResultsarray<object>

Details of the failures.

FailResultsobject
FailInfosarray<object>

Reasons for errors.

FailInfosobject
Codestring

Error code.

ACCOUNT_EXIST
CodeDescstring

Description of the error code.

TEST
Inputstring

Incorrect input value.

20
OkCountinteger

Count of successes.

1
Successboolean

Whether the request was successful. Possible values:

  • true: Request successful
  • false: Request failed
True

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
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.-
400Mail.InvalidEmail/phone number is invalid.-
400Usergroup.Not.ExistThe user group does not exist.The 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.You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.
400Feishu.User.DuplicatedFeishu account already exists or bound:%s.-
400Viewer.CannotHave.CustomRoleOrganization viewer cannot have custom roles.Organization viewer cannot have custom roles.
400UserAnalyst.NotSupport.ThisRoleThis role has permissions that analysts cannot grant.This role has permissions that analysts cannot grant.
400User.OrganizationRole.NotExistUser %s must have role in organization.User %s must have role in organization.
400FeishuUser.UserGroup.AssociationErrorFeishu User can only be added into feishu or Bi user group.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-24The Error code has changedView Change Details
2023-08-07The Error code has changedView Change Details
2022-09-08Add OperationView Change Details