一覧取得

セルフポータルのユーザ情報を取得します。

ユーザ一覧内の”テナント全員”は、仮想マシングループ/カタログの共有設定する際に利用します。
※セルフポータルUIの一覧では表示されません。

GET /api/1.0/user

Request parameters
Name Description Type Data type Required
Authorization Bearer [APIキー] header String True
pagesize 取得するデータの取得件数(default:100) query Number
startindex 取得するデータの開始位置 query Number
Successful Response
Response Code 200 OK
Response Headers Content-type: application/json
Name Description Example Data type
totalCount ユーザ情報件数 120 Number
totalModify 最終更新日 2023-01-02T11:22:33+0900 String
users ユーザ情報一覧 Array
user ユーザ情報 Object
tenantId テナントID dc5440d1038b4ffcb3fa56a613a8ac7f String
tenantName テナント名 APU9999999 String
userId ユーザID 03b9d69c8e9d485c989612ec372a0fa3 String
userNo ユーザNo 100000 String
userName ユーザ名 user01 String
fullname 名称 ユーザ01 String
mailAddress メールアドレス aaa@bbb.ccc String
roleKbn ロール区分
2:ユーザ管理者
3:ユーザ
2 String
allVmQuota 作成可能仮想マシン数 10 Number
runVmQuota パワーオン可能仮想マシン数 5 Number
passwordChangeFlg パスワード強制変更フラグ false Boolean
lockFlg ロックフラグ false Boolean
yukoFlg 有効フラグ true Boolean
createDate 登録日時 2020-08-06T17:20:32+0900 String
createUserId 登録ユーザID a5dc76bd94ef4abf9536ed441da8a581 String
modifyDate 更新日時 2020-08-06T17:20:32+0900 String
modifyUserId 更新ユーザID a5dc76bd94ef4abf9536ed441da8a581 String
実行例) 11件目から1件表示する場合
# Execute request
curl -i -X GET -H "Authorization:$token" -H "Content-Type:application/json" ¥
"https://eastapi.aspire.gcf.whitecloud.jp/api/1.0/user?startindex=11&pagesize=1"
レスポンス例
  
    {
      "totalCount": 11,
      "totalModifyDate": "2023-06-28T16:01:15+0900",
      "users": [
        {
          "tenantId": "6856a4a04db64fbea0fdea167ad45b7d",
          "tenantName": "APU9999999",
          "userId": "85c14f70d5c245cfa24c58caea32f49d",
          "userNo": "10009",
          "userName": " APU9999999",
          "fullname": "",
          "mailAddress": "",
          "roleKbn": "2",
          "allVmQuota": 0,
          "runVmQuota": 0,
          "passwordChangeFlg": true,
          "lockFlg": false,
          "yukoFlg": true,
          "createDate": "2021-12-18T02:33:50+0900",
          "createUserId": "7b3f4c67ccb0476fada954a30f5c7077",
          "modifyDate": "2021-12-18T02:33:50+0900",
          "modifyUserId": "7b3f4c67ccb0476fada954a30f5c7077"
        }
      ]
    }