• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Keystone
  5. Group
  6. Updating a User Group

Updating a User Group

Function Description

This interface is used to update user group information. This interface applies only to domain names in the Global zone.

URI

  • URI format

    PATCH /v3/groups/{group_id}

  • URI parameter description

    Parameter

    Mandatory

    Type

    Description

    group_id

    Yes

    String

    ID of a user group.

Request

  • Request header parameter description

    Parameter

    Mandatory

    Type

    Description

    Content-Type

    Yes

    String

    Fill application/json;charset=utf8 in this field.

    X-Auth-Token

    Yes

    String

    Valid token (the token of a user with the secu_admin permission under the current domain).

  • Request body parameter description

    Parameter

    Mandatory

    Type

    Description

    group

    Yes

    Object

    Request body of a group.

    description

    No

    String

    Description for a user group. The length is less than or equal to 255 bytes.

    domain_id

    No

    String

    ID of the domain to which a user group belongs.

    name

    No

    String

    Name of a user group. The length is less than or equal to 64 bytes.

  • Sample request
    curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X PATCH -d'{"group": {"description": "Contract developers 2016"}}' https://172.30.48.86:31943/v3/groups/aaec2abd4eba430fbf61541ffde76650

Response

  • Response body parameter description

    Parameter

    Mandatory

    Type

    Description

    group

    Yes

    Dict

    Response body of a user group.

    description

    Yes

    String

    Description for a user group.

    domain_id

    Yes

    String

    ID of the domain to which a user group belongs.

    id

    Yes

    String

    ID of a user group.

    links

    Yes

    Dict

    Links to a user group.

    name

    Yes

    String

    Name of a user group.

  • Sample response
    {
      "group": {
        "domain_id": "d54061ebcb5145dd814f8eb3fe9b7ac0",
        "description": "Contract developers 2016",
        "id": "aaec2abd4eba430fbf61541ffde76650",
        "links": {
          "self": "https://sample.domain.com/v3/groups/aaec2abd4eba430fbf61541ffde76650"
        },
        "name": "jixiang1"
      }
    }

Status Codes

Status Code

Description

200

The request is successful.

400

The server failed to process the request.

401

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.

409

A resource conflict occurs.

501

The API is not implemented.