コンテンツにスキップ

組織ユーザーリスト取得

目的

組織に属するユーザー(FirebaseUID)リストを取得します。

基本項目

項目 備考
url /api/admin/organization/:farm_id/users
メソッド GET
content-type application/json
文字コード utf-8

リクエスト

ヘッダ

ヘッダ名
X-fn-gene-api-idtoken Firebase ID Token

パラメータ(URL)

パラメータ名 名称 サイズ
farm_id 組織ID string 10byte

パラメータ(クエリ)

なし

ボディ(JSON)

なし

レスポンス

レスポンスステータス

HTTPステータス 内容
201 JSON
401 認証エラー
404 対象がない
500 その他エラー

ボディ(JSON)

パラメータ名 名称 サイズ 備考
uid ユーザーID String
mailaddress e-mailアドレス String
fb_result Firebaseユーザー取得結果 Number 0:正常 1:エラー(※)
fb_error Firebaseユーザー取得エラーメッセージ String

※fb_result=1はFirebase Authenticationからユーザーを削除&組織ユーザーは未削除のケースでも発生する

レスポンスサンプル

  • Content-Type Application/Json
[
  {
    "uid": "b9I23m5aN5ap6vtiKfKUaAAnxID3",
    "email": null,
    "fb_result": 1,
    "fb_error": "There is no user record corresponding to the provided identifier."
  },
  {
    "uid": "uvo1Clxsv9RM6vG8sGRfdqdgBmB2",
    "email": "fn-ml@cht.co.jp",
    "fb_result": 0,
    "fb_error": null
  },
  {
    "uid": "Usy4xvaa76hLBQmu5ZgntUwhdT53",
    "email": "noxxxxxxxx@gmail.com",
    "fb_result": 0,
    "fb_error": null
  }
]