MultipleAccountPublicClientApplication クラス

  • リファレンス
パッケージ:
com.microsoft.identity.client

public class MultipleAccountPublicClientApplication extends PublicClientApplication implements IMultipleAccountPublicClientApplication

コンストラクターの概要

コンストラクター 説明
MultipleAccountPublicClientApplication(@NonNull PublicClientApplicationConfiguration config)

メソッドの概要

修飾子と型 メソッドと説明
void acquireToken(@NonNull final Activity activity, @NonNull final String[] scopes, @Nullable final String loginHint, @NonNull final AuthenticationCallback callback)

トークンを対話形式で取得すると、webUI がポップアップ表示されます。 対話型フローはキャッシュ参照をスキップします。
IAuthenticationResult acquireTokenSilent(@NonNull String[] scopes, @NonNull IAccount account, @NonNull String authority)

トークンの取得サイレント呼び出しを実行します。 キャッシュに有効なアクセス トークンがある場合、sdk はアクセス トークンを返します。有効なアクセス トークンが存在しない場合、sdk は更新トークンを検索し、更新トークンを使用して新しいアクセス トークンを取得しようとします。 更新トークンが存在しない場合、または更新に失敗した場合、例外はコールバック経由で返送されます。
void acquireTokenSilentAsync(@NonNull final String[] scopes, @NonNull final IAccount account, @NonNull final String authority, @NonNull final SilentAuthenticationCallback callback)

トークンの取得サイレント呼び出しを実行します。 キャッシュに有効なアクセス トークンがある場合、sdk はアクセス トークンを返します。有効なアクセス トークンが存在しない場合、sdk は更新トークンを検索し、更新トークンを使用して新しいアクセス トークンを取得しようとします。 更新トークンが存在しない場合、または更新に失敗した場合、例外はコールバック経由で返送されます。
void getAccount(@NonNull final String identifier, @NonNull final GetAccountCallback callback)

識別子に一致する IAccount オブジェクトを取得します。 識別子には、homeAccountIdentifier、localAccountIdentifier、またはユーザー名を指定できます。
IAccount getAccount(@NonNull String identifier)

識別子に一致する IAccount オブジェクトを取得します。 識別子には、homeAccountIdentifier、localAccountIdentifier、またはユーザー名を指定できます。
List<IAccount> getAccounts()

このアプリケーションに RefreshTokens が含まれるオブジェクトの IAccount リストを返します。

void getAccounts(@NonNull final LoadAccountsCallback callback)

このアプリケーションが RefreshTokens を持つオブジェクトの IAccount リストを非同期的に返します。
void removeAccount(@Nullable final IAccount account, @NonNull final RemoveAccountCallback callback)

指定された IAccount のアカウントと資格情報 (トークン) を削除します。
boolean removeAccount(@Nullable IAccount account)

指定された IAccount のアカウントと資格情報 (トークン) を削除します。

継承メンバー

PublicClientApplication.acquireToken(@NonNull final Activity activity, @NonNull final String[] scopes, @NonNull final AuthenticationCallback callback) PublicClientApplication.acquireToken(@NonNull final AcquireTokenParameters acquireTokenParameters) PublicClientApplication.acquireTokenSilent( @NonNull final AcquireTokenSilentParameters acquireTokenSilentParameters) PublicClientApplication.acquireTokenSilentAsync( @NonNull final AcquireTokenSilentParameters acquireTokenSilentParameters) PublicClientApplication.acquireTokenWithDeviceCode(@Nullable String[] scopes, @NonNull final DeviceCodeFlowCallback callback) IPublicClientApplication.acquireTokenWithDeviceCode(@NonNull String[] scopes, @NonNull final DeviceCodeFlowCallback callback) PublicClientApplication.buildAcquireTokenSilentParameters(@NonNull final String[] scopes, @NonNull final IAccount account, @NonNull final String authority, final boolean forceRefresh, @Nullable final ClaimsRequest claimsRequest, @NonNull final SilentAuthenticationCallback callback) PublicClientApplication.create(@NonNull final Context context, final int configFileResourceId, @NonNull final ApplicationCreatedListener listener) PublicClientApplication.create(@NonNull final Context context, @NonNull final File configFile, @NonNull final ApplicationCreatedListener listener) PublicClientApplication.create(@NonNull final Context context, @NonNull final String clientId, @Nullable final String authority, @NonNull final String redirectUri, @NonNull final ApplicationCreatedListener listener) PublicClientApplication.create(@NonNull final Context context, final int configFileResourceId) PublicClientApplication.createMultipleAccountPublicClientApplication(@NonNull final Context context, final int configFileResourceId, @NonNull final IMultipleAccountApplicationCreatedListener listener) PublicClientApplication.createMultipleAccountPublicClientApplication(@NonNull final Context context, @NonNull final File configFile, @NonNull final IMultipleAccountApplicationCreatedListener listener) PublicClientApplication.createMultipleAccountPublicClientApplication(@NonNull final Context context, @NonNull final int configFileResourceId) PublicClientApplication.createMultipleAccountPublicClientApplication(@NonNull final Context context, @NonNull final File configFile) PublicClientApplication.createSingleAccountPublicClientApplication(@NonNull final Context context, final int configFileResourceId, @NonNull final ISingleAccountApplicationCreatedListener listener) PublicClientApplication.createSingleAccountPublicClientApplication(@NonNull final Context context, @NonNull final File configFile, @NonNull final ISingleAccountApplicationCreatedListener listener) PublicClientApplication.createSingleAccountPublicClientApplication( @NonNull final Context context, final int configFileResourceId) PublicClientApplication.createSingleAccountPublicClientApplication( @NonNull final Context context, @Nullable final File configFile) PublicClientApplication.generateSignedHttpRequest(@NonNull final IAccount account, @NonNull final PoPAuthenticationScheme popParameters) PublicClientApplication.generateSignedHttpRequest(@NonNull final IAccount account, @NonNull final PoPAuthenticationScheme popParameters, @NonNull final SignedHttpRequestRequestCallback callback) PublicClientApplication.getCommandCallback( @NonNull final SilentAuthenticationCallback authenticationCallback, @NonNull final TokenParameters tokenParameters) PublicClientApplication.getConfiguration() PublicClientApplication.getMsaFamilyRefreshToken(@NonNull final String identifier) ITokenShare.getMsaFamilyRefreshToken(String identifier) PublicClientApplication.getMsaFamilyRefreshTokenWithMetadata(@NonNull final String identifier) ITokenShare.getMsaFamilyRefreshTokenWithMetadata(String identifier) PublicClientApplication.getOrgIdFamilyRefreshToken(@NonNull final String identifier) ITokenShare.getOrgIdFamilyRefreshToken(String identifier) PublicClientApplication.getOrgIdFamilyRefreshTokenWithMetadata(@NonNull final String identifier) ITokenShare.getOrgIdFamilyRefreshTokenWithMetadata(String identifier) PublicClientApplication.getSdkVersion() PublicClientApplication.homeAccountMatcher PublicClientApplication.isSharedDevice() PublicClientApplication.localAccountMatcher PublicClientApplication.mPublicClientConfiguration PublicClientApplication.mTokenShareUtility PublicClientApplication.postAuthResult(@NonNull final ILocalAuthenticationResult localAuthenticationResult, @NonNull final TokenParameters requestParameters, @NonNull final SilentAuthenticationCallback authenticationCallback) PublicClientApplication.PublicClientApplication(@NonNull final PublicClientApplicationConfiguration configFile) PublicClientApplication.saveMsaFamilyRefreshToken(@NonNull final String refreshToken) ITokenShare.saveMsaFamilyRefreshToken(String refreshToken) PublicClientApplication.saveOrgIdFamilyRefreshToken(@NonNull final String ssoStateSerializerBlob) ITokenShare.saveOrgIdFamilyRefreshToken(String ssoStateSerializerBlob) PublicClientApplication.showExpectedMsalRedirectUriInfo(Activity activity) PublicClientApplication.usernameMatcher PublicClientApplication.validateAcquireTokenParameters(AcquireTokenParameters parameters) PublicClientApplication.validateAcquireTokenSilentParameters(AcquireTokenSilentParameters parameters)

コンストラクターの詳細

MultipleAccountPublicClientApplication

protected MultipleAccountPublicClientApplication(@NonNull PublicClientApplicationConfiguration config)

Parameters:

config

メソッドの詳細

acquireToken

public void acquireToken(@NonNull final Activity activity, @NonNull final String[] scopes, @Nullable final String loginHint, @NonNull final AuthenticationCallback callback)

トークンを対話形式で取得すると、webUI がポップアップ表示されます。 対話型フローはキャッシュ参照をスキップします。

Overrides:

MultipleAccountPublicClientApplication.acquireToken(@NonNull final Activity activity, @NonNull final String[] scopes, @Nullable final String loginHint, @NonNull final AuthenticationCallback callback)

Parameters:

activity - を起動するための親アクティビティとして使用される null Activity 以外の com.microsoft.identity.common.internal.providers.oauth2.AuthorizationActivity値です。
scopes - アクセス トークンに対して要求されるスコープの null 以外の配列。 MSAL は常にスコープ 'openid profile offline_access' を送信します。 これらのスコープをスコープ パラメーターに含めないでください。
loginHint - 省略可能。 指定した場合、 はユーザーの認証に送信されるクエリ パラメーターとして使用されます。これにより、UPN が事前に設定されます。
callback - 結果を返す Null AuthenticationCallback 以外。 1) ユーザーがデバイスの [戻る] ボタンを押してフローをキャンセルした場合、結果は を介して onCancel()返送されます。 2) SDK がトークンを正常に受け取った場合、結果は 3 を介して onSuccess(final IAuthenticationResult authenticationResult) 返送されます)他のすべてのエラーは を介して onError(final MsalException exception)返送されます。

acquireTokenSilent

public IAuthenticationResult acquireTokenSilent(@NonNull String[] scopes, @NonNull IAccount account, @NonNull String authority)

トークンの取得サイレント呼び出しを実行します。 キャッシュに有効なアクセス トークンがある場合、sdk はアクセス トークンを返します。有効なアクセス トークンが存在しない場合、sdk は更新トークンを検索し、更新トークンを使用して新しいアクセス トークンを取得しようとします。 更新トークンが存在しない場合、または更新に失敗した場合、例外はコールバック経由で返送されます。

Overrides:

MultipleAccountPublicClientApplication.acquireTokenSilent(@NonNull String[] scopes, @NonNull IAccount account, @NonNull String authority)

Parameters:

scopes - アクセス トークンに対して要求されるスコープの null 以外の配列。 MSAL は常にスコープ 'openid profile offline_access' を送信します。 これらのスコープをスコープ パラメーターに含めないでください。
account -

IAccount は、トークンをサイレントに要求するアカウントを表します。

authority - トークンを発行する権限。

acquireTokenSilentAsync

public void acquireTokenSilentAsync(@NonNull final String[] scopes, @NonNull final IAccount account, @NonNull final String authority, @NonNull final SilentAuthenticationCallback callback)

トークンの取得サイレント呼び出しを実行します。 キャッシュに有効なアクセス トークンがある場合、sdk はアクセス トークンを返します。有効なアクセス トークンが存在しない場合、sdk は更新トークンを検索し、更新トークンを使用して新しいアクセス トークンを取得しようとします。 更新トークンが存在しない場合、または更新に失敗した場合、例外はコールバック経由で返送されます。

Overrides:

MultipleAccountPublicClientApplication.acquireTokenSilentAsync(@NonNull final String[] scopes, @NonNull final IAccount account, @NonNull final String authority, @NonNull final SilentAuthenticationCallback callback)

Parameters:

scopes - アクセス トークンに対して要求されるスコープの null 以外の配列。 MSAL は常にスコープ 'openid profile offline_access' を送信します。 これらのスコープをスコープ パラメーターに含めないでください。
account -

IAccount は、トークンをサイレントに要求するアカウントを表します。

authority - トークンを発行する権限。
callback -

SilentAuthenticationCallback 結果を返すために使用される 。 成功した結果は を介して onSuccess(final IAuthenticationResult authenticationResult)返送されます。 エラーケースは{ を介して返送されます onError(final MsalException exception)

getAccount

public void getAccount(@NonNull final String identifier, @NonNull final GetAccountCallback callback)

識別子に一致する IAccount オブジェクトを取得します。 識別子には、homeAccountIdentifier、localAccountIdentifier、またはユーザー名を指定できます。

Overrides:

MultipleAccountPublicClientApplication.getAccount(@NonNull final String identifier, @NonNull final GetAccountCallback callback)

Parameters:

identifier - 識別子の文字列
callback - このアクションが完了したら通知するコールバック。

getAccount

public IAccount getAccount(@NonNull String identifier)

識別子に一致する IAccount オブジェクトを取得します。 識別子には、homeAccountIdentifier、localAccountIdentifier、またはユーザー名を指定できます。

Overrides:

MultipleAccountPublicClientApplication.getAccount(@NonNull String identifier)

Parameters:

identifier - 識別子の文字列

getAccounts

public List getAccounts()

このアプリケーションに RefreshTokens が含まれるオブジェクトの IAccount リストを返します。

Overrides:

MultipleAccountPublicClientApplication.getAccounts()

getAccounts

public void getAccounts(@NonNull final LoadAccountsCallback callback)

このアプリケーションが RefreshTokens を持つオブジェクトの IAccount リストを非同期的に返します。

Overrides:

MultipleAccountPublicClientApplication.getAccounts(@NonNull final LoadAccountsCallback callback)

Parameters:

callback - このアクションが完了したら通知するコールバック。

removeAccount

public void removeAccount(@Nullable final IAccount account, @NonNull final RemoveAccountCallback callback)

指定された IAccount のアカウントと資格情報 (トークン) を削除します。

Overrides:

MultipleAccountPublicClientApplication.removeAccount(@Nullable final IAccount account, @NonNull final RemoveAccountCallback callback)

Parameters:

account - エントリと関連するトークンを削除する必要がある IAccount。
callback

removeAccount

public boolean removeAccount(@Nullable IAccount account)

指定された IAccount のアカウントと資格情報 (トークン) を削除します。

Overrides:

MultipleAccountPublicClientApplication.removeAccount(@Nullable IAccount account)

Parameters:

account - エントリと関連するトークンを削除する必要がある IAccount。

Returns:

True を指定すると、アカウントが削除されました。 それ以外の場合は false です。

適用対象