Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDK
/
Java SDK
/
API リファレンス
/
io.realm.mongodb

クラス認証情報

項目一覧

  • io.realm.mongodb
  • ネストされたクラスの概要
  • メソッドの概要
  • 継承されたメソッド
  • メソッドの詳細
  • 匿名
  • apiKey
  • Apple
  • asJson
  • カスタム関数
  • EmailPassword
  • Facebook
  • getIdentityProvider
  • google
  • JSON web token

io.realm.mongodb

java.lang.Object
io.realm.mongodb.Credentials

認証情報は特定のログインプロバイダーへのログインを表し、MongoDB Realm によってユーザーを確認し、アクセス権を付与するために使用されます。 Provider.EMAIL_PASSWORDプロバイダーはデフォルトで有効になっています。 MongoDB Realm で他のすべてのプロバイダーを有効にする必要があります。

メール/パスワードを使用してログインするユーザーは、まずEmailPasswordAuth.registerUser( string , string )を使用して登録する必要があることに注意してください。

認証情報は、次の方法で使用されます。

// Example
App app = new App("app-id");
Credentials credentials = Credentials.emailPassword("email", "password");
User user = app.loginAsync(credentials, new App.Callback<User>() {
  @Override
  public void onResult(Result<User> result) {
    if (result.isSuccess() {
      handleLogin(result.get());
    } else {
      handleError(result.getError());
    }
  }
));
}

Tip

以下も参照してください。

  • 認証プロバイダ

ネストされたクラスの概要

修飾子と型
クラスと説明
public static final

メソッドの概要

修飾子と型
メソッドと説明
public static Credentials
anonymous ()

匿名ユーザーを表す認証情報を作成します。

public static Credentials
apiKey (
String key
)

ユーザー API キーを使用して、ログインを表す認証情報を作成します。

public static Credentials
apple (
String idToken
)

Apple ID トークンを使用して、ログインを表す認証情報を作成します。

public string
asJson ()

シリアル化された認証情報オブジェクトをJSON stringとして返します。

public static Credentials
customFunction (
Document arguments
)

リモート関数への引数として解析されるドキュメントを使用して、MongoDB Realm からリモート関数を表す認証情報を作成します。そのため、キーは関数に必要な形式と名前を一致させる必要があります。

public static Credentials
emailPassword (
String email,
String password
)

メールとパスワードを使用して、ログインを表す認証情報を作成します。

public static Credentials
facebook (
String accessToken
)

Facebook アクセス トークンを使用して、ログインを表す認証情報を作成します。

getIdentityProvider ()

認証に使用される ID プロバイダーを返します。

public static Credentials
google (
String authorizationCode
)

GoogleAuthType.AUTH_Coded Google アクセス トークンを使用して、ログインを表す認証情報を作成します。

public static Credentials
google (
String token,
GoogleAuthType type
)

指定されたGoogleAuthTypeの Google アクセス トークンを使用して、ログインを表す認証情報を作成します。

public static Credentials
jwt (
String jwtToken
)

JSON web tokenトークンを使用してログインを表す認証情報を作成します。

継承されたメソッド

  • クラス java.lang.Object から継承されたメソッド :getClass 、hashCode 、equals 、clone 、toString 、notify 、notifyAll 、wait 、wait 、wait 、finalize

メソッドの詳細

匿名

public static Credentials anonymous ()

匿名ユーザーを表す認証情報を作成します。ユーザーを再度ログアウトすると、データが失われると回復方法がなく、ユーザーの詳細をデバイス間で共有できなくなります。

ログアウト後にデータを保持するには、匿名ユーザーを別の実際のユーザーにリンクする必要があります。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

apiKey

public static Credentials apiKey (
String key
)

ユーザー API キーを使用して、ログインを表す認証情報を作成します。このプロバイダーが動作するには、MongoDB Realm で有効にする必要があります。

パラメーター

  • key - ログインに使用する API キー。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

Apple

public static Credentials apple (
String idToken
)

Apple ID トークンを使用して、ログインを表す認証情報を作成します。このプロバイダーが動作するには、MongoDB Realm で有効にする必要があります。

パラメーター

  • idToken - Apple ログインを使用するときに生成された ID トークン。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

asJson

public String asJson ()

シリアル化された認証情報オブジェクトをJSON stringとして返します。

戻り値

認証情報オブジェクトのJSONシリアル化されたstring 。

カスタム関数

public static Credentials customFunction (
Document arguments
)

リモート関数への引数として解析されるドキュメントを使用して、MongoDB Realm からリモート関数を表す認証情報を作成します。そのため、キーは関数に必要な形式と名前を一致させる必要があります。

このプロバイダーは、MongoDB Realm で有効にする必要があります。

パラメーター

  • arguments - 関数の引数を含むドキュメント。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

EmailPassword

public static Credentials emailPassword (
String email,
String password
)

メールとパスワードを使用して、ログインを表す認証情報を作成します。

パラメーター

  • email - ログインするユーザーのメール。

  • password - ログインするユーザーのパスワード。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

Facebook

public static Credentials facebook (
String accessToken
)

Facebook アクセス トークンを使用して、ログインを表す認証情報を作成します。このプロバイダーが動作するには、MongoDB Realm で有効にする必要があります。

パラメーター

  • accessToken - Facebook にログインするときに返されたアクセス トークン。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

getIdentityProvider

認証に使用される ID プロバイダーを返します。

戻り値

選択された認証情報を識別するプロバイダー。

google

public static Credentials google (
String authorizationCode
)

GoogleAuthType.AUTH_Coded Google アクセス トークンを使用して、ログインを表す認証情報を作成します。

このプロバイダーは、MongoDB Realm で有効にする必要があります。

パラメーター

  • authorizationCode - Google にログインするときに返された認証コード。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

public static Credentials google (
String token,
GoogleAuthType type
)

指定されたGoogleAuthTypeの Google アクセス トークンを使用して、ログインを表す認証情報を作成します。

このプロバイダーは、MongoDB Realm で有効にする必要があります。

パラメーター

  • token - Google にログインするときに返されたアクセス トークン。

  • type - アクセス トークンの種類

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

JSON web token

public static Credentials jwt (
String jwtToken
)

JSON web tokenトークンを使用してログインを表す認証情報を作成します。 このトークンは通常、カスタム OAuth 2ログイン フローの後に生成されます。このプロバイダーが動作するには、MongoDB Realm で有効にする必要があります。

パラメーター

  • jwtToken - 別のサービスへのカスタムログイン後に返されるJSON web tokenトークン。

戻り値

App.loginAsync(Credentials, App.Callback)を使用して MongoDB Realm にログインするために使用できる認証情報のセット。

戻る

AuthenticationLister

次へ

Credentials.Provider