Updating groups

PATCH /v3/groups/{group_id}

Change the name or description of a group with the specified ID.

Source: https://docs.openstack.org/api-ref/identity/v3/index.html?expanded=update-group-detail#update-group

Request

Parameters

Name	In	Type	Description
group_id	path	string	The group ID.
group	body	object	A group object.
description (Optional)	body	string	The description of the group.
name (Optional)	body	string	The new name of the group.

Example

# curl -ks -X PATCH -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' -d '
{
  "group": {
    "description": "Renamed domain administrators",
    "name": "my_domain_admins"
  }
}' https://<node_IP_addr>:5000/v3/groups/c0d675eac29945ad9dfd08aa1bb75751

Response

Parameters

Name	In	Type	Description
group	body	object	A group object.
description	body	string	The description of the group.
domain_id	body	string	The ID of the domain of the group.
id	body	string	The group ID.
links	body	object	The link to the group resource.
name	body	string	The name of the group.

Status codes

Success

Code	Reason
200 - OK	Request was successful.

Example

{
  "group": {
    "description": "Renamed domain administrators",
    "domain_id": "f2eeaaf15c254d4fa10255796122c8ec",
    "id": "c0d675eac29945ad9dfd08aa1bb75751",
    "links": {
      "self": "https://<node_IP_addr>:5000/v3/groups/c0d675eac29945ad9dfd08aa1bb75751"
    },
    "name": "my_domain_admins"
  }
}