CommonDeviceCodeRequest type

Paquete:
@azure/msal-common

Parámetros para el flujo de código del dispositivo Oauth2.

  • ámbitos: matriz de ámbitos a los que la aplicación solicita acceso.
  • authority: : dirección URL de la autoridad, el servicio de token de seguridad (STS) desde el que MSAL adquirirá tokens. Si la autoridad se establece en el objeto de aplicación cliente, esto invalidará ese valor. La invalidación del valor hará que la validación de la autoridad se produzca cada vez. Si se usará la misma autoridad para todas las solicitudes, establezca en el objeto de aplicación en lugar de las solicitudes.
  • correlationId: conjunto único de GUID por solicitud para realizar un seguimiento de una solicitud de un extremo a otro con fines de telemetría.
  • deviceCodeCallback: devolución de llamada que contiene la respuesta del código del dispositivo. El mensaje debe mostrarse al usuario final. Después, el usuario final puede ir a la verification_uri, escribir los user_code y las credenciales de entrada.
  • cancel: booleano para cancelar el sondeo del punto de conexión de código de dispositivo. Mientras el usuario se autentica en un dispositivo independiente, MSAL sondea el punto de conexión de token del servicio de token de seguridad para el intervalo especificado en la respuesta de código del dispositivo (normalmente 15 minutos). Para detener el sondeo y cancelar la solicitud, establezca cancel=true.
  • resourceRequestMethod: tipo de solicitud HTTP que se usa para solicitar datos del recurso (es decir, "GET", "POST", etc.). Se usa para flujos de prueba de posesión.
  • resourceRequestUri: URI para el que se usará el token. Se usa para flujos de prueba de posesión.
  • timeout: período de tiempo de espera en segundos que el usuario configura explícitamente para el sondeo del punto de conexión de código del dispositivo. Al final de este período; suponiendo que el código del dispositivo aún no ha expirado; El sondeo del código del dispositivo se detiene y se cancela la solicitud. La ventana de expiración del código de dispositivo siempre tendrá prioridad durante este período establecido.
  • extraQueryParameters: cadena a la asignación de cadenas de parámetros de consulta personalizados agregados a la cadena de consulta
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}