Change Group Information#
指定したテナントの指定グループ情報(グループ名、ポリシー)を変更します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://objectstorage-s.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://objectstorage-s.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PATCH
/v2/admin/{tenantID}/groups/{groupID}
HTTPステータスコード#
正常時:200
エラー時:400, 403, 404, 405, 409, 411, 412, 416, 422, 500, 501, 503
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
tenantID | path | string | 必須 | テナント識別子 |
groupID | path | string | 必須 | グループ識別子 |
X-Auth-Token | header | string | 必須 | 認証のトークン |
displayName | body | string | 必須(どちらかを指定) | 変更後のグループ名 - 指定しない場合、グループ名は変更されません。 - 指定した場合、displayNameのみ変更されます(レスポンスボディ部参照)。 制限値は以下です。 長さ:32Byte以下 使用可能な文字種: - 半角英数字 - +(プラス) - =(等号) - ,(カンマ) - .(ドット) - @(アットマーク) - -(ハイフン) - _(アンダースコア) |
Statement | body | array | 同上 | 次行以降を含むポリシーの主要エレメント |
Sid | body | array | Statementを指定する場合は任意 | ポリシードキュメントに与える任意の識別子 |
Action | body | array | Statementを指定する場合は必須(どちらかを指定) | バケットやオブジェクトに対して許可または拒否する操作を指定します。 指定内容については「Action/NotActionに指定できる権限」を参照してください。 |
NotAction | body | array | 同上 | 同上 |
Effect | body | array | Statementを指定する場合は必須 | ポリシーに指定する内容を、許可(Allow)するか拒否(Deny)するかを指定します。 |
Resource | body | array | Statementを指定する場合は必須(どちらかを指定) | 対象のバケットまたはオブジェクトを指定します。 URNを使用して指定してください。 指定内容については「機能説明書 ポリシーの指定項目 Resource/NotResource」 を参照してください。 |
NotResource | body | array | 同上 | 同上 |
Condition | body | array | Statementを指定する場合は任意 | ポリシーを適用する条件を示す式を設定します。 |
📒注: リクエストボディはJSON形式で指定してください。
レスポンスヘッダーの説明#
名前 | Type | Description |
---|---|---|
Date | string | トランザクションが実行された日時 |
Content-Type | string | MIME仕様で定義されているコンテントの形式 |
Content-Length | string | レスポンスボディのバイト数 |
X-Fcx-Endpoint-Request | string | このリクエストに付与されるID トラブルについて問い合わせる際に利用されます。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
apiVersion | string | APIの内部のバージョン番号 |
data | object | 次行以降を含むグループデータの情報 |
Statement | array | ポリシーの主要エレメント |
Effect | string | ポリシーに指定する内容を、許可(Allow)するか拒否(Deny)するかが表示されます。 |
Action | array | 許可する操作が表示されます。 |
NotAction | array | 拒否する操作が表示されます。 |
Resource | array | 対象とするバケットがURNで表示されます。 |
NotResource | array | 対象外とするバケットがURNで表示されます。 |
Sid | string | ポリシードキュメントに与える任意の識別子 |
Condition | array | ポリシーを適用する条件を示す式が表示されます。 |
accountId | string | テナント識別子 |
displayname | string | グループ名(表示用) |
groupURN | string | テナント識別子+グループ名 例:urn:sgws:identity::accountId:group/グループ名 |
id | string | グループ識別子 オブジェクトストレージ内で一意の識別子です。この識別子を利用してグループの操作を実施します。 |
uniqueName | string | グループ名 |
responseTime | string | 応答が生成された日時 |
status | object | 要求の結果 「success」または「error」が表示されます。 |
リクエスト例#
リクエストヘッダー
PATCH /v2/admin/46799197538990820493/groups/8a8645ae-e89e-4187-9494-a3d129ab2f2d HTTP/1.1 User-Agent: curl/7.29.0 Host: objectstorage-s.jp-east-3.cloud.global.fujitsu.com Accept: */* X-Auth-Token:gAAAAABc66w20IxL_7qupYA5wdRQFtkgHwBOTUEiSsWQG-ynIh90KdPfRNcK5o7YUNgvqFAo0P18HdO-Mynzqgz-lVRtxzfnCPgZsK5RQZ_e_sZD46wI0uPdspBpfBOW0PwEFR8VROyECHwI0nSbQP73Vzx2TmQhQH81nEt3kc7mz1YRLw4lg3c Content-Length: 154 Content-Type: application/x-www-form-urlencoded
リクエストボディ
{ "displayName": "testgroup44", "Statement": [ { "Sid": "Test group policy44", "NotAction": "s3:*", "Effect": "Deny", "NotResource": "urn:sgws:s3:::*" } ] }
レスポンス例#
レスポンスヘッダー
HTTP/1.1 200 OK Date: Mon, 27 May 2019 09:21:59 GMT Content-Type: application/json Content-Length: 410 Connection: keep-alive Api-Version: 2 Cache-Control: private, no-cache, max-age=0 Content-Security-Policy: frame-ancestors 'self'; block-all-mixed-content Expires: Mon, 27 May 2019 09:21:59 GMT Strict-Transport-Security: max-age=31536000; includeSubDomains Vary: Api-Version X-Content-Security-Policy: frame-ancestors: 'self'; block-all-mixed-content X-Content-Type-Options: nosniff X-Frame-Options: SAMEORIGIN X-Fcx-Endpoint-Request: EXECUTED_api2-rmp1.management.jp-east-3.local-1115-80089-1_200
レスポンスボディ
{ "apiVersion": "2.2", "data": { "Statement": [ { "Effect": "Deny", "NotAction": "s3:*", "NotResource": "urn:sgws:s3:::*", "Sid": "Test group policy44" } ], "accountId": "46799197538990820493", "displayName": "testgroup44", "groupURN": "urn:sgws:identity::46799197538990820493:group/testgroup4", "id": "8a8645ae-e89e-4187-9494-a3d129ab2f2d", "uniqueName": "group/testgroup4" }, "responseTime": "2019-05-27T09:21:59.362Z", "status": "success" }