CommonDeviceCodeRequest type

Paket:
@azure/msal-common

Parameter für den Oauth2-Gerätecodefluss.

  • Bereiche – Array von Bereichen, auf die die Anwendung Zugriff anfordert.
  • authority: - URL der Autorität, der Sicherheitstokendienst (SECURITY Token Service, STS), aus dem MSAL Token erwirbt. Wenn die Autorität für das Clientanwendungsobjekt festgelegt ist, überschreibt dies diesen Wert. Das Überschreiben des Werts bewirkt, dass die Autoritätsüberprüfung jedes Mal erfolgt. Wenn die gleiche Autorität für alle Anforderungen verwendet wird, legen Sie das Anwendungsobjekt anstelle der Anforderungen fest.
  • correlationId – Eindeutiger GUID-Satz pro Anforderung zur Ablaufverfolgung einer Anforderung für Telemetriezwecke.
  • deviceCodeCallback – Rückruf, der die Antwort auf Gerätecode enthält. Die Meldung sollte endbenutzern angezeigt werden. Der Endbenutzer kann dann zum verification_uri navigieren, die user_code eingeben und Anmeldeinformationen eingeben.
  • cancel – Boolean to cancel polling of device code endpoint. Während sich der Benutzer auf einem separaten Gerät authentifiziert, fragt MSAL den Tokenendpunkt des Sicherheitstokendiensts für das in der Gerätecodeantwort angegebene Intervall ab (in der Regel 15 Minuten). Wenn Sie die Abfrage beenden und die Anforderung abbrechen möchten, legen Sie "cancel=true" fest.
  • resourceRequestMethod – HTTP-Anforderungstyp, der zum Anfordern von Daten aus der Ressource verwendet wird (z. B. "GET", "POST", usw.). Wird für Besitznachweisflüsse verwendet.
  • resourceRequestUri – URI, für den das Token verwendet wird. Wird für Besitznachweisflüsse verwendet.
  • Timeout – Timeoutzeitraum in Sekunden, den der Benutzer explizit für die Abfrage des Gerätecodeendpunkts konfiguriert. Ende dieses Zeitraums; vorausgesetzt, der Gerätecode ist noch nicht abgelaufen; die Abfrage des Gerätecodes wird beendet und die Anforderung abgebrochen. Das Ablauffenster für Gerätecode hat immer Vorrang vor diesem festgelegten Zeitraum.
  • extraQueryParameters – Zeichenfolge zur Zeichenfolgenzuordnung von benutzerdefinierten Abfrageparametern, die der Abfragezeichenfolge hinzugefügt wurden
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}