サーバー構築不要！スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >REST API リファレンス:会員ログイン(新)

REST API リファレンス

共通ドキュメント

会員ログイン(新)

会員ログインAPIについて

リクエストの会員名、パスワードが会員登録されていた場合に、
ログイン成功としセッショントークンの払い出しを行います。
メールアドレス認証が許可されている場合は、
メールアドレスとパスワードによるログインが可能になります。

なお、会員名、パスワードでのログインを行うには、
アプリ設定の会員認証設定にて、ID/パスワード認証を「許可する」に設定する必要があります。
※ 参考：会員認証の方法を設定する
メールアドレス、パスワードでのログインを行うには、
アプリ設定の会員認証設定にて、メールアドレス/パスワード認証を「許可する」に設定する必要があります。
また、ログインするユーザーの mailAddressConfirm が true である必要があります。false の場合は 401 エラーとなりログイン出来ません。
※ 参考：「メールアドレス／パスワード認証」を「許可する」に設定する

基本仕様

  • APIパス：/login
  • メソッド：POST

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

会員ログイン時は、会員名かメールアドレスのいずれかを指定する必要があります。
ただし、両方を指定することはできません。

パラメータ名 説明 データ型 必須 バリデーション
userName 会員名 文字列 △ 存在チェック
有効値チェック
相関チェック
password パスワード 文字列 ○
mailAddress メールアドレス 文字列 △ 相関チェック

HTTPステータス

ステータスコード 説明
200 ログイン完了

レスポンスヘッダー

フィールド名 値
Content-Type application/json

レスポンスコンテント

パラメータ名 説明 データ型 備考
objectId オブジェクトID 文字列
userName 会員名 文字列
authData OAuth認証情報 配列 会員管理のデータ取得時にSNS認証データを含める設定を行っている場合のみOAuth認証情報を返却します。
mailAddressConfirm メールアドレス確認状態 真偽値
mailAddress メールアドレス 文字列
createDate 登録日時 日付
updateDate 更新日時 日付
sessionToken セッショントークン 文字列
- 追加フィールド -

リクエストサンプル（ID/パスワード認証）

curl -X POST \
 -H "X-NCMB-Application-Key: 43a07c1a52068463a195e6cd0cdf6d18cf5810d2db37afb37aa528d168c24bac" \
 -H "X-NCMB-Timestamp: 2023-02-15T02:14:31.397Z" \
 -H "X-NCMB-Signature: ZQhxq/il/1WbPve0z6pdx/OqNjmgNfkEY8ewYBLgSBk=" \
 -H "Content-Type: application/json" \
 -d '{"userName":"user01","password":"passwd"}' \
https://mbaas.api.nifcloud.com/2013-09-01/login

レスポンスサンプル（ID/パスワード認証）

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "objectId":"09Mp23m4bEOInUqT",
  "userName":"user01",
  "mailAddress":null,
  "mailAddressConfirm":null,
  "sessionToken":"ebDH8TtmLoygzjqjaI4EWFfxc",
  "createDate":"2023-02-11T07:46:09.801Z",
  "updateDate":"2023-02-12T05:32:03.868Z"
}

リクエストサンプル（メールアドレス/パスワード認証）

curl -X POST \
 -H "X-NCMB-Application-Key: 43a07c1a52068463a195e6cd0cdf6d18cf5810d2db37afb37aa528d168c24bac" \
 -H "X-NCMB-Timestamp: 2023-02-15T05:45:52.208Z" \
 -H "X-NCMB-Signature: Pd6jTjfFc8dRGk5q5sPXNe14lhx9iGv+2WsFpAiPuKM=" \
 -H "Content-Type: application/json" \
 -d '{"mailAddress":"your.mailaddress@example.com","password":"passwd"}' \
https://mbaas.api.nifcloud.com/2013-09-01/login

レスポンスサンプル（メールアドレス/パスワード認証）

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "objectId":"09Mp23m4bEOInUqT",
  "userName":"user02",
  "mailAddress":"your.mailaddress@example.com",
  "mailAddressConfirm":true,
  "sessionToken":"pD9nRW3CKyAgvIZGhR5IGfdWh",
  "createDate":"2023-02-11T07:46:09.801Z",
  "updateDate":"2023-02-12T05:32:03.868Z"
}

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。（回答保証はいたしかねます）
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ