PublicClientApplication class

new PublicClientApplication(configuration: Configuration, controller?: IController)

パラメーター

この関数は、eSTS トークン エンドポイントから承認コード (コードとして渡される) を引き換える。 この承認コードは、機密クライアントを使用してサーバー側で取得し、spa_codeを取得する必要があります。 この API は、通常の承認コードの取得と引き換えには使用されません。

この承認コードを利用するには、機密クライアントによって取得された PKCE は必要ありません。

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

パラメーター

返品

この関数が完了したときに満たされる約束、またはエラーが発生した場合に拒否される約束。

ユーザーのブラウザーでポップアップ ウィンドウを開き、API のaccess_tokenを取得する場合に使用します

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

パラメーター

返品

この関数が完了したときに満たされる約束、またはエラーが発生した場合に拒否される約束。

ユーザーのブラウザー ウィンドウを承認エンドポイントにリダイレクトして、API のaccess_tokenを取得する場合に使用します。 この関数はページをリダイレクトするため、この関数に続くコードは実行されません。

重要: Promise の解決に依存するコードを作成することはお勧めしません。 この関数は、現在のブラウザー ウィンドウから移動します。 現在、この関数で実行されているコードの非同期の性質を反映するために Promise が返されます。

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

パラメーター

返品

特定のスコープ セットのアクセス トークンをサイレントで取得します。 並列要求が行われた場合に、現在処理している promise を返します。

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

パラメーター

返品

• この関数が完了したときに満たされる約束、またはエラーが発生した場合に拒否される約束。 AuthenticationResult オブジェクトを返します。

配列にイベント コールバックを追加します

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

パラメーター

返品

パフォーマンス イベントを受信するためのコールバックを登録します。

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

パラメーター

返品

ブラウザー キャッシュからトークンとアカウントをクリアします。

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

パラメーター

返品

StandardController を作成し、PublicClientApplication に渡します

static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

パラメーター

返品

ユーザー アカウントが別のブラウザー タブまたはウィンドウの localstorage に追加または削除されたときにイベントを生成するイベント リスナーを削除します。

function disableAccountStorageEvents()

別のブラウザー タブまたはウィンドウでユーザー アカウントが localstorage に追加または削除されたときにイベントを生成するイベント リスナーを追加します。

function enableAccountStorageEvents()

渡されたアカウント フィルターと一致するキャッシュ内で見つかった最初のアカウントを返します。

function getAccount(accountFilter: AccountFilter): null | AccountInfo

パラメーター

返品

指定されたフィルターと一致するキャッシュ内で最初に見つかったアカウント。アカウントが見つからなかった場合は null。

homeAccountId と一致するサインインしているアカウントを返します。 (ログインが成功した時点でアカウント オブジェクトが作成されます)、一致するアカウントが見つからない場合は null

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

パラメーター

返品

MSAL に格納されているアカウント オブジェクト

localAccountId と一致するサインインしているアカウントを返します。 (ログインが成功した時点でアカウント オブジェクトが作成されます)、一致するアカウントが見つからない場合は null

function getAccountByLocalId(localId: string): null | AccountInfo

パラメーター

返品

MSAL に格納されているアカウント オブジェクト

ユーザー名と一致するサインインアカウントを返します。 (ログインが成功した時点でアカウント オブジェクトが作成されます)、一致するアカウントが見つからない場合は null。 この API は便宜上提供されていますが、最適な信頼性を得るには getAccountById を使用する必要があります

function getAccountByUsername(userName: string): null | AccountInfo

パラメーター

返品

MSAL に格納されているアカウント オブジェクト

現在アクティブなアカウントを取得します

function getActiveAccount(): null | AccountInfo

返品

オプションのフィルターに一致するキャッシュ内のすべてのアカウントを返します。 フィルターが指定されていない場合は、すべてのアカウントが返されます。

function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]

パラメーター

返品

キャッシュ内の AccountInfo オブジェクトの配列

ロガー インスタンスを返します。

function getLogger(): Logger

返品

アプリケーションのトークン キャッシュを取得します。

function getTokenCache(): ITokenCache

返品

リダイレクト フロー中に PublicClientApplication オブジェクトが読み込まれた後に、ユーザーがイベントを発生できるようにするイベント ハンドラー関数。 これは、リダイレクト認証フローに関係するすべてのページ読み込みで呼び出す必要があります。

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

パラメーター

返品

トークン応答または null。 戻り値が null の場合、認証リダイレクトは検出されませんでした。

AuthenticationResult オブジェクト内のトークンとアカウントを使用してキャッシュをハイドレートする

function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>

パラメーター

返品

WAM 拡張機能への接続などの非同期スタートアップ タスクを実行する初期化子関数

function initialize(request?: InitializeApplicationRequest): Promise<void>

パラメーター

返品

テレメトリやロガーなどに渡される SKU とバージョンを設定するために、ラッパー ライブラリ (Angular & React) によって呼び出されます。

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

パラメーター

ユーザーのブラウザーでポップアップ ウィンドウを開き、ログイン プロセスを開始するときに使用します

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

パラメーター

返品

この関数が完了したときに満たされる約束、またはエラーが発生した場合に拒否される約束。

ユーザーのブラウザーを承認エンドポイントにリダイレクトしてログイン プロセスを開始するときに使用します。 この関数はページをリダイレクトするため、この関数に続くコードは実行されません。

重要: Promise の解決に依存するコードを作成することはお勧めしません。 この関数は、現在のブラウザー ウィンドウから移動します。 現在、この関数で実行されているコードの非同期の性質を反映するために Promise が返されます。

function loginRedirect(request?: RedirectRequest): Promise<void>

パラメーター

返品

非推奨のログアウト関数。 代わりに logoutRedirect または logoutPopup を使用する

function logout(logoutRequest?: EndSessionRequest): Promise<void>

パラメーター

返品

現在のユーザーのローカル キャッシュをクリアし、サーバーからサインアウトするようにユーザーに求めるポップアップ ウィンドウを開きます。

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

パラメーター

返品

現在のユーザーをログアウトし、ユーザーを postLogoutRedirectUri にリダイレクトするために使用します。 既定の動作では、ユーザーを window.location.hrefにリダイレクトします。

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

パラメーター

返品

指定された ID を持つコールバックをコールバック配列から削除します

function removeEventCallback(callbackId: string)

パラメーター

addPerformanceCallback に登録されているコールバックを削除します。

function removePerformanceCallback(callbackId: string): boolean

パラメーター

返品

アクティブなアカウントとして使用するアカウントを設定します。 acquireToken API にアカウントが渡されない場合、MSAL はこのアクティブなアカウントを使用します。

function setActiveAccount(account: null | AccountInfo)

パラメーター

構成で設定された既定のロガーを新しい Logger に新しい構成に置き換えます

function setLogger(logger: Logger)

パラメーター

ナビゲーション クライアントを設定します

function setNavigationClient(navigationClient: INavigationClient)

パラメーター

この関数では、非表示の iframe を使用して、eSTS から承認コードをフェッチします。 これが機能しない場合があります。

• インテリジェント追跡防止の形式を使用する任意のブラウザー
• サービスとのセッションが確立されていない場合

このような場合、要求はポップアップまたはフル フレーム リダイレクト内で行う必要があります。

対話が必要な場合は、prompt=none で要求を送信できません。

更新トークンの有効期限が切れている場合は、サーバー上のセッションがまだ存在する限り、この関数を使用してトークンの新しいセットをサイレント でフェッチできます。

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

パラメーター

返品

この関数が完了したときに満たされる約束、またはエラーが発生した場合に拒否される約束。