Get Group Information List#
指定したテナントのグループ一覧を取得します。
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#
GET
/v2/admin/{tenantID}/groups
HTTPステータスコード#
正常時:200
エラー時:400, 403, 404, 405, 409, 411, 412, 416, 422, 500, 501, 503
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
tenantID | path | string | 必須 | テナント識別子 |
limit | query | integer | 25 任意 |
最大表示件数 一度に指定できる最大件数は500です。 |
marker | query | string | 任意 | Group URNを指定します。 例:urn:sgws:identity::tenantID:group/グループ名 |
includeMarker | query | boolean | false 任意 |
- true:markerを含めてグループを表示します。 - false:markerを含めずグループを表示します。 |
X-Auth-Token | header | string | 必須 | 認証のトークン |
レスポンスヘッダーの説明#
名前 | 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からuniqueNameまでを含むグループデータの情報 |
Statement | array | ポリシーの主要エレメント |
Action | array | 許可する操作が表示されます。 |
NotAction | array | 拒否する操作が表示されます。 |
Condition | array | ポリシーを適用する条件を示す式が表示されます。 |
Effect | string | ポリシーに指定する内容を、許可(Allow)するか拒否(Deny)するかが表示されます。 |
Resource | array | 対象とするバケットがURNで表示されます。 |
NotResource | array | 対象外とするバケットがURNで表示されます。 |
Sid | string | ポリシードキュメントに与える任意の識別子 |
accountId | string | テナント識別子 |
displayname | string | グループ名(表示用) |
groupURN | string | テナント識別子+グループ名 例:urn:sgws:identity::accountId:group/グループ名 |
id | string | グループ識別子 オブジェクトストレージ内で一意の識別子です。この識別子を利用してグループの操作を実施します。 |
uniqueName | string | グループ名 |
responseTime | string | 応答が生成された日時 |
status | object | 要求の結果 「success」または「error」が表示されます。 |
リクエスト例#
リクエストヘッダー
GET /v2/admin/46799197538990820493/groups HTTP/1.1 User-Agent: curl/7.29.0 Host: objectstorage-s.jp-east-3.cloud.global.fujitsu.com Accept: */* X-Auth-Token:gAAAAABc64XNFPq8d1vIw_I4sVHsuS0l685hlBoqyQbbCmKm1W4dGLHtvMz8nW7B9dSkKy67mWZj6aH7B7KM4lj418km222LwbhHqed75s3LsPYmpLioTu0saVPfu_AsqlHk-4vRQ3ggQC4bIxRaC4UBi1pvnc0gpQzgxqbOYLnEixQ8Knc1KWQ
レスポンス例#
レスポンスヘッダー
HTTP/1.1 200 OK Date: Mon, 27 May 2019 06:38:06 GMT Content-Type: application/json Content-Length: 1382 Connection: keep-alive Api-Version: 2 Cache-Control: no-cache Content-Security-Policy: frame-ancestors 'self'; block-all-mixed-content Expires: Mon, 27 May 2019 06:38:06 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_api3-rmp2.management.jp-east-3.local-12528-61160-1_200
レスポンスボディ
{ "apiVersion": "2.2", "data": [ { "Statement": [ { "Action": "s3:*", "Effect": "Allow", "Resource": "urn:sgws:s3:::*", "Sid": "Test group policy" } ], "accountId": "46799197538990820493", "displayName": "testgroup1", "groupURN": "urn:sgws:identity::46799197538990820493:group/testgroup1", "id": "ada6ce1c-8a98-4a5b-940c-8776e3885e0d", "uniqueName": "group/testgroup1" }, { "Statement": [ { "Action": "s3:*", "Condition": { "StringEquals": { "sgws:username": "user01" } }, "Effect": "Allow", "Resource": "urn:sgws:s3:::*", "Sid": "Test group policy" } ], "accountId": "46799197538990820493", "displayName": "testgroup2", "groupURN": "urn:sgws:identity::46799197538990820493:group/testgroup2", "id": "7ce930f9-cd79-4b4e-a3e1-a48a9523bc73", "uniqueName": "group/testgroup2" }, { "Statement": [ { "Action": "s3:*", "Effect": "Allow", "Resource": "urn:sgws:s3:::*" } ], "accountId": "46799197538990820493", "displayName": "testgroup3", "groupURN": "urn:sgws:identity::46799197538990820493:group/testgroup3", "id": "9c945522-9df9-4f3a-9626-218f0d9433df", "uniqueName": "group/testgroup3" }, { "Statement": [ { "Effect": "Allow", "NotAction": "s3:*", "NotResource": "urn:sgws:s3:::*", "Sid": "Test group policy" } ], "accountId": "46799197538990820493", "displayName": "testgroup4", "groupURN": "urn:sgws:identity::46799197538990820493:group/testgroup4", "id": "8a8645ae-e89e-4187-9494-a3d129ab2f2d", "uniqueName": "group/testgroup4" } ], "responseTime": "2019-05-27T06:38:06.257Z", "status": "success" }