03-6417-9339

平日 9:30 ~ 12:00 / 13:00 ~ 17:30

user_add


ユーザーを新規登録するためのエンドポイントです。

エンドポイント user_add
機能 ユーザー新規登録
実装バージョン 2.8.0
認証 有り
HTTPメソッド GET/POST

パラメータ

入力値 機能 入力値の型 デフォルト値
q[api_key] パラメータで認証を行う場合に API キーを指定します。
X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。
String なし
q[login] ログイン名を入力します。 String なし
q[lastname] ユーザーの苗字を入力します。 String なし
q[firstname] ユーザーの名前を入力します。 String なし
q[password] パスワードを入力します。 String なし
q[mail_address] メールアドレスを入力します。 String なし
q[auth] 認証方式を入力します。 String なし
q[role] ユーザー権限を入力します。 String なし
q[categories][] カテゴリを配列入力します。カテゴリ名で指定します。例:[ '#1', '#011' ] Array<String> なし
q[category_group_ids][] カテゴリグループの ID を配列入力します。 Array<Number> なし
q[last_login_on] 最後のログイン日時を入力します。 String なし
q[mail_notification] お知らせメールの有効無効を指定します。true, false で指定します。 Boolean なし
q[lock] ユーザーロックの有無を指定します。true, false で指定します。 Boolean なし
q[must_change_password] 次回ログイン時のパスワード変更を要求するかを指定します。true, false で指定します。 Boolean なし

レスポンス

key value の内容 value の型
success 新規登録の成否 Boolean
response エラー等の補足情報 Hash

レスポンス例

{
  "success": true,
  "response": {},
  "id":50
}

サンプルコード (作成中)