Updating User Group Information

Function

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

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

PATCH /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.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
group	Yes	Object	User group information.

**Table 4** group
Parameter	Mandatory	Type	Description
description	No	String	User group description, which must contain less than or equal to 255 characters. Either name or description must be specified.
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 contains 1 to 128 characters. Either name or description must be specified.

Response Parameters

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

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

**Table 7** group.links
Parameter	Type	Description
self	String	Resource link.

Example Request

Request for changing the user group name to IAMGroup and description to IAMDescription

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

{
    "group": {
        "description": "IAMDescription",
        "domain_id": "d78cbac186b744899480f25bd02...",
        "name": "IAMGroup"
    }
}

Example Response

Status code: 200

The request is successful.

{
    "group": {
        "description": "IAMDescription",
        "links": {
            "self": "https://iam.myhuaweicloud.com/v3/groups/077a4da48a00251f3f9dc0032103400f"
        },
        "id": "077a4da48a00251f3f9dc0032103400f",
        "create_time": 1578969360636,
        "domain_id": "d78cbac186b744899480f25bd...",
        "name": "IAMGroup"
    }
}

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.
409	A resource conflict occurs.
501	The API is not available.