Get User 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}/users

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	任意	User URNを指定します。例：urn:sgws:identity::tenantID:user/ユーザ名
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	accountIdからuserURNまでを含むユーザーデータの情報
accountId	string	テナント識別子
fullName	string	ユーザー名(表示用)
id	string	ユーザー識別子オブジェクトストレージ内で一意の識別子です。この識別子を利用してユーザーの操作を実施します。
memberOf	array	ユーザを所属させるグループID(複数指定可)
uniqueName	string	ユーザー名
userURN	string	テナント識別子＋ユーザー名例：urn:sgws:identity::accountId:user/ユーザ名
responseTime	string	応答が生成された日時
status	object	要求の結果「success」または「error」が表示されます。

リクエスト例#

リクエストヘッダー

GET /v2/admin/46799197538990820493/users HTTP/1.1
User-Agent: curl/7.29.0
Host: objectstorage-s.jp-east-3.cloud.global.fujitsu.com
Accept: */*
X-Auth-Token:gAAAAABc73CiBwfEJeFAH9JC3dPGAuMbpEUVyY0wKDigNqufx7JRZ8mHzN4wRdtE-KnsPnKp5kmyCSV4n3ntHHLcWPGjdqXG9JrGkePaho20zn-PEKVrx9QPxbpJEEkV0OxDjTV8QL80SzPk3x9Y4MDwjoNXj6e7IK--sT8PEflgkJJ4TQ7CrdM

レスポンス例#

レスポンスヘッダー

HTTP/1.1 200 OK
Date: Thu, 30 May 2019 05:56:50 GMT
Content-Type: application/json
Content-Length: 1273
Connection: keep-alive
Api-Version: 2
Cache-Control: no-cache
Content-Security-Policy: frame-ancestors 'self'; block-all-mixed-content
Expires: Thu, 30 May 2019 05:56:50 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-28848-123580-1_200

レスポンスボディ

{
    "apiVersion": "2.2",
    "data": [
        {
            "accountId": "46799197538990820493",
            "fullName": "Root",
            "id": "00000000-0000-0000-0000-000000000000",
            "memberOf": null,
            "uniqueName": "root",
            "userURN": "urn:sgws:identity::46799197538990820493:root"
        },
        {
            "accountId": "46799197538990820493",
            "fullName": "testuser01",
            "id": "1f3a2a93-883a-4205-812c-58c62de0e9c2",
            "memberOf": [
                "25aefd91-1d71-4e34-a3f8-55b54639cc2f"
            ],
            "uniqueName": "user/testuser01",
            "userURN": "urn:sgws:identity::46799197538990820493:user/testuser01"
        },
        {
            "accountId": "46799197538990820493",
            "fullName": "testuser02",
            "id": "b8bc75f1-9985-4a71-9172-d74235e08832",
            "memberOf": null,
            "uniqueName": "user/testuser02",
            "userURN": "urn:sgws:identity::46799197538990820493:user/testuser02"
        },
        {
            "accountId": "46799197538990820493",
            "fullName": "testuser03",
            "id": "b15c5e23-4858-4489-ac19-b3c793aed9ee",
            "memberOf": [
                "25aefd91-1d71-4e34-a3f8-55b54639cc2f",
                "57687db1-1faa-495d-8663-27bfe7f9c12b"
            ],
            "uniqueName": "user/testuser03",
            "userURN": "urn:sgws:identity::46799197538990820493:user/testuser03"
        },
        {
            "accountId": "46799197538990820493",
            "fullName": "testuser04",
            "id": "1f067f79-cf97-4f74-9a90-aa492485b8b6",
            "memberOf": null,
            "uniqueName": "user/testuser04",
            "userURN": "urn:sgws:identity::46799197538990820493:user/testuser04"
        }
    ],
    "responseTime": "2019-05-30T05:56:50.896Z",
    "status": "success"
}