Querying the IAM Users in a Group

Function

This API can be used by the administrator to query the IAM users in a user group.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

Debugging

You can debug this API in API Explorer.

URI

GET /v3/groups/{group_id}/users

**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
links	Object	User group resource link.
users	Array of objects	IAM user information.

**Table 4** links
Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link. If the previous resource link is unavailable, this parameter is set to null.
next	String	Next resource link. If the next resource link is unavailable, this parameter is set to null.

**Table 5** users
Parameter	Type	Description
name	String	IAM username.
links	Object	IAM user resource link information.
domain_id	String	ID of the account used to create the IAM user.
enabled	Boolean	Enabling status of the IAM user. true (default value) indicates that the user is enabled. false indicates that the user is disabled.
id	String	IAM user ID.
password_expires_at	String	Password expiration time. If this parameter is set to null, the password will never expire. NOTE: The value is a UTC time in the YYYY-MM-DDTHH:mm:ss.ssssss format, for example, 2023-06-28T08:56:33.710000.
description	String	Description of the IAM user.
access_mode	String	Access type of the IAM user. default: programmatic access and management console access. This option is the default access type. programmatic: programmatic access console: management console access
pwd_status	Boolean	Password status. true indicates that the password needs to be changed, and false indicates that the password is normal. If no password is set, this parameter may not be returned.
last_project_id	String	ID of the project that the IAM user last accessed before logging out. If the user has not accessed any project, this parameter may not be returned.
pwd_strength	String	Password strength. The value can be high, mid, or low. If the user does not set the password, this parameter may not be returned.

**Table 6** users.links
Parameter	Type	Description
self	String	Resource link.
previous	String	Previous resource link. If the previous resource link is unavailable, this parameter is set to null.
next	String	Next resource link. If the next resource link is unavailable, this parameter is set to null.

Example Request

Request for querying the IAM users in a group

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

Example Response

Status code: 200

The request is successful.

{
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.com/v3/groups/07609e7eb200250a3f7dc003cb7a4e2d/users"
    },
    "users": [
        {
            "pwd_status": true,
            "domain_id": "d78cbac186b744899480f25bd...",
            "last_project_id": "065a7c66da0010992ff7c0031e...",
             "name": "IAMUserA",
            "description": "--",
            "password_expires_at": null,
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/users/07609fb9358010e21f7bc00375..."
            },
            "id": "07609fb9358010e21f7bc003751c7...",
            "enabled": true
        },
        {
            "pwd_status": true,
            "domain_id": "d78cbac186b744899480f25bd022...",
            "last_project_id": "065a7c66da0010992ff7c0031e5a...",
            "name": "IAMUserB",
            "description": "",
            "password_expires_at": null,
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/users/076837351e80251c1f0fc003af..."
            },
            "id": "076837351e80251c1f0fc003afe43...",
            "enabled": true
        }
    ]
}