All Products
Search
Document Center

Quick BI:ListUserGroupsByUserId

Last Updated:Nov 04, 2025

Queries all user groups to which a user belongs based on the user ID.

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:ListUserGroupsByUserIdlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserIdstringYes

The ID of the user. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.

46e5374665ba4b679ee22e2a2927****

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
RequestIdstring

The ID of the request.

E2440604-3059-561A-AD68-DEDBC870EB2B
Resultarray<object>

The information about the group.

Dataobject
IdentifiedPathstring

Directory level of the user group.

2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
ParentUsergroupIdstring

The ID of the user group.

2fe4fbd8-588f-489a-b3e1-e92c7af0****
ModifiedTimestring

The time when the user group was last modified.

2021-03-15 20:36:40
CreateUserstring

The user group creator. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.

46e5374665ba4b679ee22e2a2927****
UsergroupNamestring

The name of the user group.

Test user group
CreateTimestring

The time when the user group was created.

2021-03-15 17:13:55
UsergroupDescstring

The description of the user group.

Description
UsergroupIdstring

The ID of the user group.

34fd141d-4598-4093-8c33-8e066dcb****
ModifyUserstring

The user group modifier. The UserID of the Quick BI is used instead of the UID of Alibaba Cloud.

46e5374665ba4b679ee22e2a2927****

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "E2440604-3059-561A-AD68-DEDBC870EB2B",
  "Result": [
    {
      "IdentifiedPath": "2fe4fbd8-588f-489a-b3e1-e92c7af0****/3d2c23d4-2b41-4af8-a1f5-f6390f32****/f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
      "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
      "ModifiedTime": "2021-03-15 20:36:40",
      "CreateUser": "46e5374665ba4b679ee22e2a2927****",
      "UsergroupName": "Test user group\n",
      "CreateTime": "2021-03-15 17:13:55",
      "UsergroupDesc": "Description\n",
      "UsergroupId": "34fd141d-4598-4093-8c33-8e066dcb****",
      "ModifyUser": "46e5374665ba4b679ee22e2a2927****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400Instance.ExpiredYour instance has expired.Your instance has expired.
400Instance.Not.ExistThe specified instance does not exist.The specified instance does not exist.
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.The specified organizational unit does not exist.
400User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
400System.Param.emptyThis error code has been discarded.-
400Internal.System.ErrorAn internal system error occurred.An internal system error occurred.

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