Help Center/ Identity and Access Management/ API Reference/ API/ IAM User Management/ Querying the IAM Users in a Group
Updated on 2023-09-14 GMT+08:00
View PDF

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.

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.

next

String

Next resource link.
Table 5 users

Parameter

Type

Description

name

String

IAM user name.

links

Object

IAM user resource link information.

domain_id

String

ID of the account to which the IAM user belongs.

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.ssssssZ format, for example, 2023-06-28T08:56:33.710000Z. For details about the date and timestamp formats, see ISO-8601.

description

String

Description of the IAM user.

pwd_status

Boolean

Password status. true means that the password needs to be changed, and false means that the password is normal.

last_project_id

String

ID of the project that the IAM user lastly accessed before exiting the system.

pwd_strength

String

Password strength. The value can be high, mid, or low.

extra

object

Other information about the IAM user.
Table 6 users.extra

Parameter

Type

Description

description

string

Description of the IAM user.

last_project_id

string

ID of the project that the IAM user lastly accessed before exiting the system.

pwd_status

boolean

Password status. true means that the password needs to be changed, and false means that the password is normal.
Table 7 Users.links

Parameter

Type

Description

self

String

Resource link.

previous

String

Previous resource link.

next

String

Next resource link.

Example Request

Request for querying the IAM users in a group

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

Example Response

Status code: 200

The request is successful.

{
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.eu/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.eu/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.eu/v3/users/076837351e80251c1f0fc003af..."
            },
            "id": "076837351e80251c1f0fc003afe43...",
            "enabled": true
        }
    ]
}

Status Codes

Status Code

Description

200

The request is successful.

400

Invalid parameters.

401

Invalid parameters.

403

Access denied.

404

The requested resource cannot be found.

Error Codes

None

Parent topic: IAM User Management