CommonAuthorizationUrlRequest type

サーバーからコードを取得するためにユーザーによって渡されたオブジェクトを要求する (承認コード付与フローの最初の区間)

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求
  • authority - アプリケーションがトークンを取得する機関の URL。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • redirectUri - アプリケーションが認証応答を受信できるリダイレクト URI。 Azure ポータルに登録されているリダイレクト URI のいずれかと完全に一致している必要があります。
  • extraScopesToConsent - ユーザーが事前に同意する必要がある場合の別のリソースのスコープ。
  • responseMode - 認証結果をアプリに送信するために使用するメソッドを指定します。 クエリ、form_post、フラグメントを指定できます。 値が渡されない場合は、既定でクエリが実行されます。
  • codeChallenge - Proof of Key for Code Exchange (PKCE) を使用して承認コード付与をセキュリティで保護するために使用されます。 詳細については、PKCE RCF を参照してください。https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod - コード チャレンジ パラメーターのコード検証ツールをエンコードするために使用されるメソッド。 "plain" または "S256" を指定できます。 除外した場合、コード チャレンジはプレーンテキストと見なされます。 詳細については、PKCE RCF を参照してください。 https://tools.ietf.org/html/rfc7636
  • state - トークン応答にも返される要求に含まれる値。 ランダムに生成された一意の値は、通常、クロスサイト リクエスト フォージェリ攻撃を防ぐために使用されます。 状態は、認証要求が発生する前のアプリ内のユーザーの状態に関する情報をエンコードするためにも使用されます。
  • prompt - 必要なユーザー操作の種類を示します。 login: ユーザーがその要求に対して資格情報を入力するように強制し、シングル サインオンなしを否定します。これにより、ユーザーに対話型プロンプトが表示されなくなります。 シングル サインオンを使用して要求を完了できない場合、エンドポイントは interaction_required エラーの同意を返します。ユーザーがサインインした後に OAuth 同意ダイアログがトリガーされ、ユーザーにアプリへのアクセス許可の付与を求めるselect_account: セッション内のすべてのアカウントまたは記憶されているアカウントまたは別のアカウントの作成を選択するオプションを一覧表示するアカウント選択エクスペリエンスを提供すると、シングル サインオンが中断されます。 は、ログイン エクスペリエンスの代わりにユーザーをアカウント作成エクスペリエンスに誘導no_session:ユーザーを認証するときに既存のセッション トークンを読み取りません。 ユーザーが正常に認証されると、EVO はユーザーの新しいセッションを作成しません。 内部使用のみ。
  • account - getAccount API から取得した AccountInfo。 loginHint パラメーターと sid パラメーターの両方が指定されていない場合は、特定のシナリオでlogin_hintを生成するために使用されます。
  • loginHint - ユーザー名/メール アドレスがわかっている場合は、ユーザーのサインイン ページのユーザー名/メール アドレス フィールドを事前に入力するために使用できます。 多くの場合、アプリは再認証時にこのパラメーターを使用します。これは、preferred_username要求を使用して以前のサインインからユーザー名を既に抽出しています。
  • sid - セッション ID、セッションの一意識別子。 ID トークンの省略可能な要求として使用できます。
  • domainHint - ユーザーがサインインに使用するテナントまたはドメインに関するヒントを提供します。 ドメイン ヒントの値は、テナントの登録済みドメインです。
  • extraQueryParameters - /authorize 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • nonce - ID トークンで返される要求に含まれる値。 ランダムに生成された一意の値は、通常、リプレイ攻撃を軽減するために使用されます。
  • resourceRequestMethod - リソースからのデータ要求に使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
type CommonAuthorizationUrlRequest = BaseAuthRequest & {
  account?: AccountInfo
  codeChallenge?: string
  codeChallengeMethod?: string
  domainHint?: string
  earJwk?: string
  extraQueryParameters?: StringDict
  extraScopesToConsent?: string[]
  loginHint?: string
  nonce: string
  platformBroker?: boolean
  prompt?: string
  redirectUri: string
  responseMode: ResponseMode
  sid?: string
  state: string
}