CommonDeviceCodeRequest type

Pakket:
@azure/msal-common

Parameters voor de Oauth2-apparaatcodestroom.

  • bereiken: matrix met bereiken waartoe de toepassing toegang aanvraagt.
  • instantie: - URL van de instantie, de beveiligingstokenservice (STS) van waaruit MSAL tokens zal verkrijgen. Als de instantie is ingesteld voor clienttoepassingsobject, wordt deze waarde overschreven. Als u de waarde overschrijft, wordt de validatie van de instantie elke keer uitgevoerd. Als dezelfde instantie wordt gebruikt voor alle aanvragen, stelt u het toepassingsobject in plaats van de aanvragen in.
  • correlationId : unieke GUID-set per aanvraag om een end-to-end aanvraag te traceren voor telemetriedoeleinden.
  • deviceCodeCallback - Callback met antwoord op apparaatcode. Het bericht moet worden weergegeven aan de eindgebruiker. Eindgebruikers kunnen vervolgens naar de verification_uri navigeren, de user_code en invoerreferenties invoeren.
  • cancel - Booleaanse waarde om polling van eindpunt van apparaatcode te annuleren. Terwijl de gebruiker zich verifieert op een afzonderlijk apparaat, controleert MSAL het tokeneindpunt van de beveiligingstokenservice voor het interval dat is opgegeven in het antwoord op de apparaatcode (meestal 15 minuten). Als u de polling wilt stoppen en de aanvraag wilt annuleren, stelt u cancel=true in.
  • resourceRequestMethod - HTTP-aanvraagtype dat wordt gebruikt om gegevens op te vragen van de resource (bijvoorbeeld 'GET', 'POST', enzovoort). Wordt gebruikt voor proof-of-possession-stromen.
  • resourceRequestUri - URI waarvoor dat token wordt gebruikt. Wordt gebruikt voor proof-of-possession-stromen.
  • time-out: time-outperiode in seconden die de gebruiker expliciet configureert voor de polling van het eindpunt van de apparaatcode. Aan het einde van deze periode; ervan uitgaande dat de apparaatcode nog niet is verlopen; de polling van apparaatcode is gestopt en de aanvraag is geannuleerd. Het verloopvenster van de apparaatcode heeft altijd voorrang op deze ingestelde periode.
  • extraQueryParameters - Tekenreeks naar tekenreekstoewijzing van aangepaste queryparameters toegevoegd aan de querytekenreeks
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}