CommonDeviceCodeRequest type

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

Oauth2 デバイスコードフローのパラメーター。

scopes - アプリケーションがアクセスを要求しているスコープの配列。
authority: - 機関の URL、MSAL がトークンを取得するセキュリティトークンサービス (STS)。クライアント・アプリケーション・オブジェクトに権限が設定されている場合、その値はオーバーライドされます。値をオーバーライドすると、毎回機関の検証が行われます。すべての要求に同じ権限が使用される場合は、要求の代わりにアプリケーション・オブジェクトに設定します。
correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
deviceCodeCallback - デバイスコード応答を含むコールバック。エンドユーザーにメッセージを表示する必要があります。エンドユーザーは、verification_uriに移動し、user_codeを入力し、資格情報を入力できます。
cancel - デバイスコードエンドポイントのポーリングを取り消すブール値。ユーザーが別のデバイスで認証されている間、MSAL は、デバイスコード応答で指定された間隔 (通常は 15 分) のセキュリティトークンサービスのトークンエンドポイントをポーリングします。ポーリングを停止して要求を取り消すには、cancel=true を設定します。
resourceRequestMethod - リソースからのデータ要求に使用される HTTP 要求の種類 ("GET"、"POST"など)。所有証明フローに使用されます。
resourceRequestUri - トークンが使用される URI。所有証明フローに使用されます。
timeout - ユーザーがデバイスコードエンドポイントのポーリング用に明示的に構成するタイムアウト期間 (秒単位)。この期間の終了時。デバイスコードの有効期限がまだ切れていないと仮定します。デバイスコードのポーリングが停止され、要求が取り消されました。デバイスコードの有効期限ウィンドウは、この設定された期間よりも常に優先されます。
extraQueryParameters - クエリ文字列に追加されたカスタムクエリパラメーターの文字列マップへの文字列

type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}