ユーザー詳細削除API

指定されたパラメーターでユーザー詳細情報を削除する。

メソッド

POST

パス

/user_detail/delete/{object_id}

Name	型	概要
object_id(必須)	文字列	オブジェクトID

リクエストボディ

Name	型	概要
tenant_id(必須)	文字列	テナントID ※別途お渡しした内容をご利用ください。
contents.user_id(必須)	文字列	ユーザーID ※顧客番号とユーザーアクセストークンといずれか必須
contents.user_no(必須)	文字列	顧客番号 ※ユーザーIDとユーザーアクセストークンといずれか必須
contents.user_access_token(必須)	文字列	ユーザーアクセストークン ※ユーザーIDと顧客番号といずれか必須
contents.search_condition.{field_name}(必須)	オブジェクト	検索条件
contents.visibility	文字列	公開範囲 ※未指定時は「0001:非公開」が設定されます。

ヒント

contents.search_condition.{field_name}には name、age_configなどの削除するユーザーの検索条件の項目名を指定します。

レスポンスボディ

Name	型	概要
status(必須)	文字列	ステータスコード
message(必須)	文字列	実行メッセージ
contents.detail_message	文字列、配列	エラーメッセージ
contents.mst_delete_cnt	数値	削除件数 ※正常時のみ付加

レスポンスの例

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "mst_delete_cnt": 12
  }
}