Help Center/ Identity and Access Management/ API Reference/ API/ User Group Management/ Checking Whether an IAM User Belongs to a User Group
Updated on 2024-07-30 GMT+08:00

Checking Whether an IAM User Belongs to a User Group

Function

This API is provided for the administrator to check whether an IAM user belongs to a specified 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

HEAD /v3/groups/{group_id}/users/{user_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.

user_id

Yes

String

IAM user ID. For details about how to obtain a user 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

None

Example Request

Request for checking whether an IAM user belongs to a user group

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

Example Response

None

Status Codes

Status Code

Description

204

The request is successful. (The IAM user belongs to the user group.)

400

Invalid parameters.

401

Authentication failed.

403

Access denied.

404

The requested resource cannot be found. (The IAM user does not belong to the user group.)

Error Codes

None