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

Listing User Groups

Function

This API is provided for the administrator to list all user groups.

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

URI

GET /v3/groups

Table 1 Query parameters

Parameter

Mandatory

Type

Description

domain_id

No

String

Account ID. For details about how to obtain the account ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

name

No

String

User group name, which can contain a maximum of 64 characters. For details about how to obtain a user group name, 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

groups

Array of objects

User group information.

links

Object

Resource link information.

Table 4 groups

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.

Example Request

Request for querying a list of user groups

GET https://iam.myhuaweicloud.eu/v3/groups

Example Response

Status code: 200

The request is successful.

{
    "groups": [
        {
            "domain_id": "d78cbac186b744899480f25bd02...",
            "create_time": 1536293929624,
            "name": "IAMGroupA",
            "description": "IAMDescription",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.eu/v3/groups/5b050baea9db472c88cbae67..."
            },
            "id": "5b050baea9db472c88cbae6..."
        },
        {
            "domain_id": "d78cbac186b744899480f25...",
            "create_time": 1578107542861,
            "name": "IAMGroupB",
            "description": "IAMDescription",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.eu/v3/groups/07609e7eb200250a3f7dc003cb7a4e2d"
            },
            "id": "07609e7eb200250a3f7dc003cb..."
        }
    ],
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.eu/v3/groups"
    }
}

Status Codes

Status Code

Description

200

The request is successful.

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

Error Codes

None