コンテンツにスキップ

組織ユーザー削除API

目的

組織に属するユーザー(Firebase UID)を削除します。

基本項目

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

リクエスト

ヘッダ

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

パラメータ(URL)

パラメータ名 名称 型 サイズ
farm_id 組織ID string 10byte
uid Firebase UID FirebaseユーザーID

パラメータ(クエリ)

なし

ボディ(JSON)

なし

レスポンス

レスポンスステータス

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

ボディ(JSON)

パラメータ名 名称 型 サイズ
uid ユーザーID String
farm_id 組織ID String 10Byte
regist_date 登録日時 Timestamp

※削除内容がレスポンスされます。

レスポンスサンプル

  • Content-Type Application/Json
{
  "uid": "uvo1Clxsv9RM6vG8sGRfdqdgBmB2",
  "farmid": "sXpE1ckVhP",
  "regist_date": "2022-06-05T12:19:44.674Z"
}