CommonDeviceCodeRequest type

Pacchetto:
@azure/msal-common

Parametri per il flusso del codice del dispositivo Oauth2.

  • ambiti: matrice di ambiti a cui l'applicazione richiede l'accesso.
  • authority: - URL dell'autorità, il servizio token di sicurezza (STS) da cui MSAL acquisirà i token. Se l'autorità è impostata sull'oggetto applicazione client, verrà eseguito l'override di tale valore. Se si esegue l'override del valore, la convalida dell'autorità verrà eseguita ogni volta. Se la stessa autorità verrà usata per tutte le richieste, impostare sull'oggetto applicazione anziché sulle richieste.
  • correlationId: GUID univoco impostato per richiesta per tracciare una richiesta end-to-end per scopi di telemetria.
  • deviceCodeCallback: callback contenente la risposta del codice del dispositivo. Il messaggio deve essere visualizzato all'utente finale. L'utente finale può quindi passare al verification_uri, immettere il user_code e le credenziali di input.
  • cancel: valore booleano per annullare il polling dell'endpoint del codice del dispositivo. Mentre l'utente esegue l'autenticazione in un dispositivo separato, MSAL esegue il polling dell'endpoint del token del servizio token di sicurezza per l'intervallo specificato nella risposta al codice del dispositivo (in genere 15 minuti). Per interrompere il polling e annullare la richiesta, impostare cancel=true.
  • resourceRequestMethod : tipo di richiesta HTTP usato per richiedere dati dalla risorsa (ad esempio "GET", "POST" e così via). Usato per i flussi di prova del possesso.
  • resourceRequestUri: URI per cui verrà usato il token. Usato per i flussi di prova del possesso.
  • timeout: periodo di timeout in secondi in cui l'utente configura in modo esplicito per il polling dell'endpoint del codice del dispositivo. Alla fine di questo periodo; supponendo che il codice del dispositivo non sia ancora scaduto; il polling del codice del dispositivo viene arrestato e la richiesta annullata. La finestra di scadenza del codice del dispositivo avrà sempre la precedenza su questo periodo impostato.
  • extraQueryParameters - Stringa per la mappa di stringhe dei parametri di query personalizzati aggiunti alla stringa di query
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}