Use GetUserGroupInfo to search for user group information - Quick BI - Alibaba Cloud - Quick BI

Searches for user group information by user group name keyword.

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:GetUserGroupInfo

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	Yes	The keyword of the user group name.	Test user group

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5
Result	array<object>	The user group information.
	object
CreateTime	string	The time when the user group was created, in the format of YYYY-MM-DD HH:mm:ss.	2021-03-15 17:13:55
CreateUser	string	The creator of the child user group. This is the UserID in Quick BI, not the UID of the Alibaba Cloud account.	46e5374665ba4b679ee22e2a2927****
IdentifiedPath	string	The folder hierarchy of the user group.	2fe4fbd8-588f-489a-b3e1-e92c7af0**/34fd141d-4598-4093-8c33-8e066dcb**
ModifiedTime	string	The time when the user group was last modified, in the format of YYYY-MM-DD HH:mm:ss.	2021-03-15 20:36:40
ModifyUser	string	The user who last modified the user group. This is the UserID in Quick BI, not the UID of the Alibaba Cloud account.	46e5374665ba4b679ee22e2a2927****
ParentUsergroupId	string	The ID of the parent user group.	2fe4fbd8-588f-489a-b3e1-e92c7af0****
UsergroupDesc	string	The description of the user group.	Test description
UsergroupId	string	The ID of the user group.	34fd141d-4598-4093-8c33-8e066dcb****
UsergroupName	string	The name of the user group.	Test user group 01

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.