RedirectRequest type

パッケージ:
@azure/msal-browser

RedirectRequest: サーバーからコードを取得するためにユーザーが渡したオブジェクトを要求します (承認コード許可フローの最初の区間) と完全なページ リダイレクト。

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • authority - アプリケーションがトークンを取得する機関の URL。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • redirectUri - アプリケーションが認証応答を受信できるリダイレクト URI。 Azure ポータルに登録されているリダイレクト URI のいずれかと完全に一致している必要があります。
  • extraScopesToConsent - ユーザーが事前に同意する必要がある場合の別のリソースのスコープ。
  • state - トークン応答にも返される要求に含まれる値。 ランダムに生成された一意の値は、通常、クロスサイト リクエスト フォージェリ攻撃を防ぐために使用されます。 状態は、認証要求が発生する前のアプリ内のユーザーの状態に関する情報をエンコードするためにも使用されます。
  • prompt - 必要なユーザー操作の種類を示します。 login: ユーザーがその要求に対して資格情報を入力するように強制し、シングル サインオンなしを否定します。これにより、ユーザーに対話型プロンプトが表示されなくなります。 シングル サインオンを使用して要求を完了できない場合、エンドポイントは interaction_required エラーの同意を返します。ユーザーがサインインした後に OAuth 同意ダイアログがトリガーされ、ユーザーにアプリへのアクセス許可の付与を求めるselect_account: セッション内のすべてのアカウントまたは記憶されているアカウントを一覧表示するアカウント選択エクスペリエンスを提供するシングル サインオンが中断されます。または、別のアカウント作成を使用することを選択するオプションが提供されます。 は、ログイン エクスペリエンスの代わりにユーザーをアカウント作成エクスペリエンスに誘導no_session:ユーザーを認証するときに既存のセッション トークンを読み取りません。 ユーザーが正常に認証されると、EVO はユーザーの新しいセッションを作成しません。 内部使用のみ。
  • loginHint - ユーザー名/メール アドレスがわかっている場合は、ユーザーのサインイン ページのユーザー名/メール アドレス フィールドを事前に入力するために使用できます。 多くの場合、アプリは再認証時にこのパラメーターを使用します。login_hintまたはpreferred_username要求を使用して、以前のサインインからユーザー名が既に抽出されています。
  • sid - セッション ID、セッションの一意識別子。 ID トークンの省略可能な要求として使用できます。
  • domainHint - ユーザーがサインインに使用するテナントまたはドメインに関するヒントを提供します。 ドメイン ヒントの値は、テナントの登録済みドメインです。
  • extraQueryParameters - /authorize 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • tokenBodyParameters - /token 呼び出しに追加されたカスタム トークン要求本文パラメーターの文字列マップへの文字列。 アクセス トークンを更新する場合にのみ使用されます。
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • 要求 - Azure AD テナント管理者が条件付きアクセス ポリシーを有効にしていて、ポリシーが満たされていない場合、例外には同意する必要がある要求が含まれます。
  • nonce - ID トークンで返される要求に含まれる値。 ランダムに生成された一意の値は、通常、リプレイ攻撃を軽減するために使用されます。
  • redirectStartPage - loginRedirect または acquireTokenRedirect の後に返されるページ。 これは、これが redirectUri と異なり、要求を開始するページに既定で設定される場合にのみ使用する必要があります。 navigateToLoginRequestUrl 構成オプションが false に設定されている場合、このパラメーターは無視されます。
  • onRedirectNavigate - MSAL が移動する URL を渡すコールバック。 コールバックで false を返すと、ナビゲーションが停止します。
type RedirectRequest = Partial<
  Omit<
    CommonAuthorizationUrlRequest,
    | "responseMode"
    | "scopes"
    | "earJwk"
    | "codeChallenge"
    | "codeChallengeMethod"
    | "requestedClaimsHash"
    | "platformBroker"
  >
> & {
  onRedirectNavigate?: (url: string) => boolean | void
  redirectStartPage?: string
  scopes: string[]
}