Update Group#
グループを更新します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://identity.gls.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://identity.gls.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PATCH
/v3/groups/{group_id}
HTTPステータスコード#
正常時:200
エラー時:400, 401, 403, 404, 409, 500, 501, 503
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
Content-type | header | string | 必須 | MIME仕様で定義されているコンテントの形式を示します。 「application/json」を指定します。 |
Accept | header | string | 任意 | MIME仕様で定義されているアクセプトの形式を示します。 「application/json」を指定します(省略可)。 |
X-Auth-Token | header | string | 必須 | 有効な認証トークン |
group_id | path | string | 必須 | グループID |
group | body | object | 必須 | グループオブジェクト |
description | body | string | 任意 | グループの説明 入力値は、「Create Group」を参照してください。 |
name | body | string | 必須 | グループ名 入力値は、「Create Group」を参照してください。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
Vary | string | 以下のヘッダーを設定または変更することで、別のファイル形式で表現を要求できることを通知します。 X-Auth-Token |
Content-Type | string | MIME仕様で定義されているコンテントの形式を示します。 「application/json」が表示されます。 |
Content-Length | int | エンティティの長さをバイトで示します。 |
Date | date | 作成された日付 |
group | object | グループオブジェクト |
description | string | グループの説明 |
domain_id | string | ドメインID |
id | string | グループID |
links | object | グループへのリンク情報 |
name | string | グループ名 |
リクエスト例#
{ "group": { "description": "secret projects", "name": "Secure Developers" } }
レスポンス例#
{ "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" } }