Querying User Group Details

Updated on 2023-09-14 GMT+08:00

View PDF

Function

This API is provided for the administrator to query user group information.

The API can be called using both the global endpoint and region-specific endpoints.

URI

GET /v3/groups/{group_id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
group_id	Yes	String	User group ID. For details about how to obtain a user group ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
X-Auth-Token	Yes	String	Access token issued to a user to bear its identity and permissions. For details about the permissions required by the token, see Actions.

Response Parameters

**Table 3** Parameters in the response body
Parameter	Type	Description
group	Object	User group information.

**Table 4** group
Parameter	Type	Description
description	String	User group description.
id	String	User group ID.
domain_id	String	ID of the account to which the user group belongs.
name	String	User group name.
links	Object	User group resource link.
create_time	Long	Time when the user group was created.

**Table 5** group.links
Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link.
next	String	Next resource link.

Example Request

Request for querying user group details

GET https://iam.myhuaweicloud.eu/v3/groups/{group_id}

Example Response

Status code: 200

The request is successful.

{
    "group": {
        "domain_id": "d78cbac186b744899480f25bd02...",
        "create_time": 1578107542861,
        "name": "IAMGroup",
        "description": "",
        "links": {
            "next": null,
            "previous": null,
            "self": "https://iam.myhuaweicloud.eu/v3/groups/07609e7eb200250a3f7dc003cb7a..."
        },
        "id": "07609e7eb200250a3f7dc003cb7..."
    }
}

Status Codes

Status Code	Description
200	The request is successful.
400	Invalid parameters.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.

Error Codes

None

Parent topic: User Group Management

Previous topic: Listing User Groups

Next topic: Creating a User Group

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel