ユーザー登録

POSThttps://manabeat.com/{site_id}/mana_apis/user_create

新規ユーザーを登録します。

パスパラメータ

site_idstringrequired

サイトID

リクエストボディ

loginstringrequired

ログインID

last_namestringrequired

姓

first_namestringrequired

名

last_name_kanastring

姓(カナ)

first_name_kanastring

名(カナ)

emailstring

メールアドレス

email2string

メールアドレス(サブ)

passwordstringrequired

パスワード

valid_start_datestring

有効開始日(yyyy/mm/dd)

valid_end_datestring

有効終了日(yyyy/mm/dd)

rolestringrequired

権限名(例:受講者(student))

group_codes[string]

グループコード

properties[string]

属性名

invalid_flagboolean

無効

temporary_user_flagboolean

仮登録

languagestring

使用言語名(デフォルト:日本語 (Japanese))

notestring

備考

scheduled_signup_mailboolean

ログインID発行通知メール送信(trueの場合はemail必須)

*saml_idps[string]

SAML認証用ユーザーID

* オプション利用中のみ

レスポンスボディ

idinteger

登録されたユーザーのユーザーID(エラー返却時はnull)

status_codestring

レスポンスステータスが返却されます

messagestring

API実行結果(正常値:"ユーザーを登録しました。")

エラーレスポンス

400URLに誤りがあります。

リクエストURL、パスパラメータを確認してください。

400Content-Type情報が不正な値です。

リクエストヘッダー情報を確認してください。

400リクエスト内容を認識できません。

リクエストボディの読み込みに失敗しました。送信データを確認してください。

400ユーザー登録数が上限に達しています。

サイトに登録されているユーザー数が契約内容の上限に達しています。

400必須パラメータが不足しています。parameter1…

一覧情報取得に必須のパラメータが不足しています。

400登録出来ないデータが含まれています。parameter1…

メッセージに記載された項目のデータが登録できません。文字数、データ型等確認してください。

403認証に失敗しました。

APIの認証に失敗しました。サイトID、APIキー、APIキー保有ユーザーの状況を確認してください。

403許可されていないIPからのリクエストです。

IPアドレス制限によってリクエストが制限されています。

413リクエストボディサイズが上限に達しています。

送信できるリクエストボディのサイズは100KBです。

429リクエスト制限中です。

1時間あたりのリクエストが5000回を超えています。時間を空けてからお試しください。

500予期せぬエラーが発生しました。

システム内部でエラーが発生しました。時間をおいて再度お試しください。

503システムメンテナンス中です。

現在システム全体のメンテナンス中です。終了までお待ちください。

リクエストボディ例

{ "login": "example001", "last_name": "学習", "first_name": "太郎", "last_name_kana": "ガクシュウ", "first_name_kana": "タロウ", "email": "api1@example.com", "email2": "api2@example.com", "password": "1234abcd", "valid_start_date": "2024-09-01", "valid_end_date": "2027-08-31", "role": "受講者(student)", "group_codes": [ "english", "math" ], "properties": [ "生徒", "1年生" ], "invalid_flag": false, "temporary_user_flag": false, "language": "英語 (English)", "note": "備考欄", "saml_idps": [ "SAMLUSERID001" ] }