CommonDeviceCodeRequest type

Paquet:
@azure/msal-common

Paramètres du flux de code d’appareil Oauth2.

  • étendues : tableau d’étendues auquel l’application demande l’accès.
  • autorité : - URL de l’autorité, service de jeton de sécurité (STS) à partir duquel MSAL acquiert des jetons. Si l’autorité est définie sur l’objet d’application cliente, cela remplace cette valeur. La substitution de la valeur entraîne la validation de l’autorité à chaque fois. Si la même autorité sera utilisée pour toutes les requêtes, définissez sur l’objet d’application au lieu des demandes.
  • correlationId : ensemble de GUID unique par requête pour tracer une requête de bout en bout à des fins de télémétrie.
  • deviceCodeCallback : rappel contenant la réponse du code d’appareil. Le message doit être affiché à l’utilisateur final. L’utilisateur final peut ensuite accéder au verification_uri, entrer le user_code et les informations d’identification d’entrée.
  • cancel : booléen pour annuler l’interrogation du point de terminaison de code de l’appareil. Bien que l’utilisateur s’authentifie sur un appareil distinct, MSAL interroge le point de terminaison de jeton du service de jeton de sécurité pour l’intervalle spécifié dans la réponse du code de l’appareil (généralement 15 minutes). Pour arrêter l’interrogation et annuler la requête, définissez cancel=true.
  • resourceRequestMethod : type de requête HTTP utilisé pour demander des données à partir de la ressource (par exemple, « GET », « POST », etc.). Utilisé pour les flux de preuve de possession.
  • resourceRequestUri : URI pour lequel le jeton sera utilisé. Utilisé pour les flux de preuve de possession.
  • délai d’expiration : période d’expiration en secondes que l’utilisateur configure explicitement pour l’interrogation du point de terminaison de code de l’appareil. À la fin de cette période ; en supposant que le code de l’appareil n’a pas encore expiré ; l’interrogation du code de l’appareil est arrêtée et la demande a été annulée. La fenêtre d’expiration du code d’appareil est toujours prioritaire sur cette période définie.
  • extraQueryParameters - Chaîne à carte de chaîne des paramètres de requête personnalisés ajoutés à la chaîne de requête
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}