グループの更新 (PATCH /v3/groups/{group_id})
指定されたグループを更新する。
更新したグループ情報が全リージョンに反映されるまで、最大10分程度が必要となる。
Request Headers
Content-type
MIME仕様で定義されているコンテントの形式を示す。
application/jsonを指定する。(必須項目)
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Accept
MIME仕様で定義されているアクセプトの形式を示す。
application/jsonを指定する。(省略可)
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
X-Auth-Token
有効な認証トークン
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Request Parameter
group_id
グループID(必須項目)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | なし | None |
group
グループオブジェクト(必須項目)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | なし | description
name |
description
グループの説明
入力値は、「グループの追加 (POST /v3/groups)」を参照
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | (group) | None |
name
グループ名
入力値は、「グループの追加 (POST /v3/groups)」を参照
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 0..1 | (group) | None |
Response Headers
HTTPステータスコード
リクエストのHTTPステータスコードを返却する。
以下の値を返却する。
- 200:
- 正常終了
- 400:
- 不正なアクセス(パラメーター不正等)
- 401:
- 認証エラー
- 403:
- アクセス不可(権限がない)
- 404:
- 該当資源なし
- 409:
- データ競合が発生
- 500:
- 予期せぬエラー
- 501:
- 実装されていない
- 503:
- サービス利用不可
Data Type | Cardinality |
---|---|
int | 1..1 |
Vary
以下のヘッダーを設定または変更することで、別のファイル形式で表現を要求できることを通知する。
X-Auth-Token
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Content-Type
MIME仕様で定義されているコンテントの形式を示す。
application/json
Data Type | Cardinality |
---|---|
xsd:string | 1..1 |
Content-Length
エンティティの長さをバイトで示す。
Data Type | Cardinality |
---|---|
int | 1..1 |
Date
作成された日付を示す。
Data Type | Cardinality |
---|---|
date | 1..1 |
Response Elements
group
groupオブジェクト
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | なし | description
domain_id id links name |
description
グループの説明
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | group | None |
domain_id
ドメインID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | group | None |
id
グループID
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | group | None |
links
グループのリンク情報
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Element | 1..1 | group | self |
name
グループ名
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
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"
}
}