Update group (PATCH /v3/groups/{group_id})

Updates the specified group.

Request headers

Content-type

Indicates the format of content defined in the MIME specification.

Specify application/json. (required)

Data type Cardinality
xsd:string 1..1

Accept

Indicates the accept format defined in the MIME specification.

Specify application/json. (optional)

Data type Cardinality
xsd:string 1..1

X-Auth-Token

Valid authentication token

Data type Cardinality
xsd:string 1..1

Request parameters

group_id

Group ID (required)

Data type Cardinality Parent element Child element
xsd:string 1..1 None None

group

Group object (required)

Data type Cardinality Parent element Child element
Element 1..1 None description

name

description

Description of group

Refer to "Create group (POST /v3/groups)" for details on input values

Data type Cardinality Parent element Child element
xsd:string 0..1 (group) None

name

Group name

Refer to "Create group (POST /v3/groups)" for details on input values

Data type Cardinality Parent element Child element
xsd:string 0..1 (group) None

Response headers

HTTP status code

Returns the HTTP status code of the request.

One of the following values will be returned.

200:
Normal completion
400:
Invalid access (invalid parameter, etc.)
401:
Authentication error
403:
Cannot access (no privileges)
404:
No applicable resources
409:
Data conflict occurred
500:
Unexpected error
501:
Has not been implemented
503:
Cannot use service
Data type Cardinality
int 1..1

Vary

By setting or changing the following header, notification is given that expressions can be requested in a different file format.

X-Auth-Token

Data type Cardinality
xsd:string 1..1

Content-Type

Indicates the format of content defined in the MIME specification.

application/json

Data type Cardinality
xsd:string 1..1

Content-Length

Indicates the length of an entity in bytes.

Data type Cardinality
int 1..1

Date

Indicates the date when the request was created.

Data type Cardinality
date 1..1

Response elements

group

group object

Data type Cardinality Parent element Child element
Element 1..1 None description

domain_id

id

links

name

description

Description of group

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

domain_id

Domain ID

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

id

ID of the group

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

links

Link information of group

Data type Cardinality Parent element Child element
Element 1..1 group self

name

Group name

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

Example of request


       {
    "group": {
        "description": "secret projects",
        "name": " Secure Developers"
    }
}

Example of response


       {
    "group": {
        "description": "secret projects",
        "domain_id": "--domain-id--",
        "id": "--group-id--",
        "links": {
            "self": "http://identity.gls.cloud.global.fujitsu.com/v3/groups/--group-id--"
        },
        "name": "Secure Developers"
    }
}