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
}