DeviceCodeRequest type

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

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

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • authority: - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。 クライアント・アプリケーション・オブジェクトに権限が設定されている場合、その値はオーバーライドされます。 値をオーバーライドすると、毎回機関の検証が行われます。 すべての要求に同じ権限が使用される場合は、要求の代わりにアプリケーション・オブジェクトに設定します。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • deviceCodeCallback - デバイス コード応答を含むコールバック。 エンド ユーザーにメッセージを表示する必要があります。 エンド ユーザーは、verification_uriに移動し、user_codeを入力し、資格情報を入力できます。
  • cancel - デバイス コード エンドポイントのポーリングを取り消すブール値。 ユーザーが別のデバイスで認証されている間、MSAL は、デバイス コード応答で指定された間隔 (通常は 15 分) のセキュリティ トークン サービスのトークン エンドポイントをポーリングします。 ポーリングを停止して要求を取り消すには、cancel=true を設定します。
  • extraQueryParameters - クエリ文字列に追加されたカスタム クエリ パラメーターの文字列マップへの文字列
type DeviceCodeRequest = Partial<
  Omit<
    CommonDeviceCodeRequest,
    | "scopes"
    | "deviceCodeCallback"
    | "resourceRequestMethod"
    | "resourceRequestUri"
    | "requestedClaimsHash"
    | "storeInCache"
  >
> & {
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  scopes: string[]
}