All Products
Search
Document Center

Quick BI:GetUserGroupInfo

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.

Search for user group information based on the keyword of the user group name.

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

Request parameters

ParameterTypeRequiredDescriptionExample
KeywordstringYes

Keyword of the user group name.

test

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request was successful. Possible values:

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

Request ID.

D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5
Resultarray<object>

User group information.

Dataobject
CreateTimestring

Creation time of the user group.

2021-03-15 17:13:55
CreateUserstring

Creator of the sub-user group. This is the UserID in Quick BI, not the UID in Alibaba Cloud.

46e5374665ba4b679ee22e2a2927****
IdentifiedPathstring

Directory level of the user group.

2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****
ModifiedTimestring

Last modified time of the user group.

2021-03-15 20:36:40
ModifyUserstring

Modifier of the user group. This is the UserID in Quick BI, not the UID in Alibaba Cloud.

46e5374665ba4b679ee22e2a2927****
ParentUsergroupIdstring

Parent user group ID.

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

Description of the user group.

test
UsergroupIdstring

User group ID.

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

Name of the user group.

test

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5",
  "Result": [
    {
      "CreateTime": "2021-03-15 17:13:55",
      "CreateUser": "46e5374665ba4b679ee22e2a2927****",
      "IdentifiedPath": "2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****",
      "ModifiedTime": "2021-03-15 20:36:40",
      "ModifyUser": "46e5374665ba4b679ee22e2a2927****",
      "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
      "UsergroupDesc": "test",
      "UsergroupId": "34fd141d-4598-4093-8c33-8e066dcb****",
      "UsergroupName": "test"
    }
  ]
}

Error codes

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