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

トップ >ドキュメント >会員管理・認証（Unity）:基本的な使い方

このサイトを正しく表示するためには、ブラウザーのJavaScriptの設定を「有効」にしてください。

会員管理・認証（Unity）

iOS
(Swift)
iOS
(Obj-C)
Android
(Kotlin)
Android
(Java)
JavaScript
Monaca
Unity

基本的な使い方

概要

ニフクラ mobile backend での会員の認証方法は以下の4種類です。

ユーザー名・パスワードでの認証
メールアドレス・パスワードでの認証
- 会員管理・認証 (Unity) : メールアドレス認証
SNSアカウントでの認証
匿名認証
- 会員管理・認証 (Unity) : 匿名認証

このページでは、ユーザー名・パスワードでの認証方法について説明していきます。
その他の認証方法を実装する場合は、各ドキュメントをご覧ください。

アプリでの実装

ユーザーの新規登録

User のインスタンスを作成後、UserName と Password を設定して SignUpAsync メソッドで登録処理を行います。

//　Userインスタンスの生成
NCMBUser user = new NCMBUser();

// ユーザー名・パスワードを設定
user.UserName = "Yamada Tarou"; /* ユーザー名 */
user.Password = "password"; /* パスワード */
user.Add("phone", "987-654-3210"); /* 任意フィールドも追加可能 */

// ユーザーの新規登録処理
user.SignUpAsync((NCMBException e) => {
    if (e != null) {
        UnityEngine.Debug.Log ("ユーザーの新規登録に失敗: " + e.ErrorMessage);
    } else {
        UnityEngine.Debug.Log ("ユーザーの新規登録に成功");
    }
});

// ユーザー名とパスワードでログイン
NCMBUser.LogInAsync ("Yamada Tarou", "password", (NCMBException e) => {
    if (e != null) {
        UnityEngine.Debug.Log ("ログインに失敗: " + e.ErrorMessage);
    } else {
        UnityEngine.Debug.Log ("ログインに成功！");
    }
});

また、ログインすることでログインしたユーザーはカレントユーザーとして設定されます。カレントユーザーの権限で mBaaS 上のオブジェクトにアクセスできるようになります。

参考：データストア(Unity)：アクセス権限設定

セッショントークン

ログインするとセッショントークンが発行されます。通信時に利用されるセッショントークンは、カレントユーザーに設定されているものです。ログアウトすることでセッショントークンを無効にし、ログイン状態を終了します。

セッショントークンの有効期限は通常24時間です
有効期限切れのセッショントークンでは通信できません
セッショントークンの有効期限は管理画面にて変更可能です

カレントユーザー

ログイン中のユーザーはカレントユーザーとして設定されます。 CurrentUserプロパティを用いることで、現在カレントユーザーに設定されているユーザ情報を取得することができます。
また、画面遷移などによって保持していたセッショントークン情報が失われた場合にも、
CurrentUserプロパティで、ローカルに保存されているカレントユーザー情報から
セッショントークンを設定をし直すことができます。

// カレントユーザー情報の取得
NCMBUser currentUser = NCMBUser.CurrentUser;
if (currentUser != null) {
    UnityEngine.Debug.Log ("ログイン中のユーザー: " + currentUser.UserName);
} else {
    UnityEngine.Debug.Log ("未ログインまたは取得に失敗");
}

参考：自動ログイン処理を実現するには？
アプリ再起動時に自動ログインを実施したい場合は、カレントユーザーを取得した上でセッショントークンの有効期限が切れていないかどうかを確認する処理の実装が必要です。

ログアウト

ログアウトは LogOutAsync メソッドを利用します。ログアウトすることで、カレントユーザー情報がリセットされます。

// ログアウト
try {
    NCMBUser.LogOutAsync ();
} catch (NCMBException e) {
    UnityEngine.Debug.Log ("エラー: " + e.ErrorMessage);
}

参考：インスタンスを用いてログインしている場合の注意点
ログアウトによりシステム上のセッショントークンは無効となりますが、インスタンスのプロパティは残ります。プロパティが残っているとセッショントークンの再取得ができないため、同一ユーザで再度ログインする場合には事前にインスタンスのログアウトを実行する必要があります。

会員の削除

会員の削除は DeleteAsync メソッドを利用します。会員を削除することで、会員管理に保存されているデータが物理削除されます。

//カレントユーザーを取得
NCMBUser user = NCMBUser.CurrentUser;
//会員のデータを削除
user.DeleteAsync((NCMBException e) => { 
    if (e != null) {
        //失敗時の処理
    } else {
        //成功時処理
    }
};

※2022年6月30日以降、App Store Review ガイドライン 5.1.1において、アカウント作成に対応しているすべてのAppを対象に、App内でアカウントを削除できるようにしなければならないという要件が追加されました。詳細はこちら

メールアドレス確認の有無

メールアドレスが確認済みかどうかを調べるにはユーザーのmailAddressConfirmキーを使用します。

参考：「メールアドレス確認」とは？
メールアドレス認証を利用する場合、ユーザーの新規登録時に登録メールアドレス宛にメールを配信し、配信されたメールから認証を行う手順があります。この手順が実施されている状態が「メールアドレス確認済み」となります。他の認証方法でもユーザー情報にメールアドレスを設定することが可能ですが、「メールアドレス確認」が実施されていないアカウントはメールアドレス認証を利用できません。

NCMBUser user = NCMBUser.CurrentUser;
if (user != null) {
    if (user.ContainsKey("mailAddressConfirm") && user["mailAddressConfirm"] != null) {
        if((bool)user["mailAddressConfirm"]){
            // メールアドレス確認済み
        } else {
            // メールアドレス未確認
        }
    }
}

パスワードのリセット

パスワードのリセットはメールアドレスの登録があるユーザーのみ行えます。以下のようにリセット要求を発行すると、登録メールアドレスに

仮パスワード
会員パスワード変更ページのURL

が送信されます。会員パスワード変更ページでパスワードの変更が可能です。
なお、URLの有効期限は24時間です。メールを受信してから24時間ではありませんので、ご注意ください。

参考：パスワード変更 API は用意しておりません。パスワードの変更を行いたい場合はパスワードのリセットの処理が必要です。

NCMBUser.RequestPasswordResetAsync("mail@example.com", (error) => {
    if (error != null){
        // エラー処理
    } else {
        // 送信後処理
    }
});

ユーザー検索

NCMBQueryを使うことでユーザーの検索をすることができます。

NCMBQuery<NCMBUser> query = NCMBUser.GetQuery ();
query.WhereEqualTo ("userName", "Yamada Tarou");
query.FindAsync ((List<NCMBUser> userList , NCMBException e) => {
    if (e != null) {
        UnityEngine.Debug.Log ("失敗 : " + e.Message);
    } else {
        foreach (NCMBUser user in userList) {
            UnityEngine.Debug.Log ("ユーザー名: " + user.UserName);
        }
    }
});

ユーザーの検索時は、検索対象のユーザーに付与されているACL設定にご注意ください。
ユーザー新規作成時にACLの設定を付与しない場合(デフォルト)は、
自分自身にのみ読込、書込権限が与えられています。
そのため、検索をかける時は、検索者に対して読込権限が与えられている必要があります。

ポインタ

データストアのポインタ同様、あるオブジェクトのプロパティにほかのオブジェクトをセットすることで、それらを関連づけることができます。

オブジェクトのプロパティにほかのオブジェクトを直接入力した場合、保存時にそのオブジェクトへのポインタが設定されます。

※ログイン済みの会員情報に追加する必要があるため、カレントユーザー情報に紐づけます

//ポインタで紐づけたい会員情報のobjectIdを会員管理に追加する
NCMBUser user = new NCMBUser();
user.ObjectId = "対象オブジェクトID";

// カレントユーザー情報の取得
NCMBUser currentUser = NCMBUser.CurrentUser;
if (currentUser != null) {
    UnityEngine.Debug.Log ("ログイン中のユーザー: " + currentUser.UserName);
    //カレントユーザー情報にポインタで紐づける
    currentUser.Add("任意のフィールド名", user);
    currentUser.SaveAsync ((NCMBException ex) => {      
        if (e != null) {
            //エラー処理
        } else {
            //成功時の処理
        }                   
    });

} else {
    UnityEngine.Debug.Log ("未ログインまたは取得に失敗");
}

機能導入済みSceneとPrefab

Sceneについて

「Assets/Scenes/Member」内に会員機能のサンプルコードを導入した「LoginSignin.scene」と「LogOut.scene」を用意しました。
2つのSceneにはNCMBSettings, NCMBManagerと会員機能導入済みのCanvasが含まれています。NCMBSettingsにアプリケーションキー、クライアントキーを入力の上、動作確認にお使いください。

Prefabについて

以下の3つの手順をすることにより会員管理・認証のログインやログアウト機能をUIに実装可能です。

クイックスタート実施
「Assets/Prefabs/Member」のフォルダ内にある導入したいprefabをどちらか1つHierarrchyにドラッグアンドドロップ
- 「LoginSignupCanvas.prefab」（ログイン、サインアップ機能）
- 「LogoutCanvas.prefab」（ログアウト機能）
Hierarchyで右クリック → UI -> 「EventSystem」の追加