CommonDeviceCodeRequest type
Parametry przepływu kodu urządzenia Oauth2.
- scopes — tablica zakresów, do których aplikacja żąda dostępu.
- authority: — adres URL urzędu, usługa tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny. Jeśli urząd jest ustawiony dla obiektu aplikacji klienckiej, spowoduje to zastąpienie tej wartości. Zastąpienie wartości spowoduje, że walidacja urzędu będzie miała miejsce za każdym razem. Jeśli ten sam urząd będzie używany dla wszystkich żądań, ustaw dla obiektu aplikacji zamiast żądań.
- correlationId — unikatowy zestaw identyfikatorów GUID na żądanie w celu śledzenia kompleksowego żądania na potrzeby telemetrii.
- deviceCodeCallback — wywołanie zwrotne zawierające odpowiedź kodu urządzenia. Komunikat powinien być wyświetlany użytkownikowi końcowemu. Użytkownik końcowy może następnie przejść do verification_uri, wprowadzić user_code i poświadczenia wejściowe.
- cancel — wartość logiczna, aby anulować sondowanie punktu końcowego kodu urządzenia. Podczas uwierzytelniania użytkownika na oddzielnym urządzeniu biblioteka MSAL sonduje punkt końcowy tokenu usługi tokenu zabezpieczającego dla interwału określonego w odpowiedzi kodu urządzenia (zwykle 15 minut). Aby zatrzymać sondowanie i anulować żądanie, ustaw wartość cancel=true.
- resourceRequestMethod — typ żądania HTTP używany do żądania danych z zasobu (np. "GET", "POST" itp.). Służy do przepływu dowodu posiadania.
- resourceRequestUri — identyfikator URI, dla którego będzie używany token. Służy do przepływu dowodu posiadania.
- limit czasu — limit czasu w sekundach, w których użytkownik jawnie konfiguruje sondowanie punktu końcowego kodu urządzenia. Na koniec tego okresu; przy założeniu, że kod urządzenia nie wygasł jeszcze; sondowanie kodu urządzenia zostało zatrzymane i żądanie zostało anulowane. Okno wygasania kodu urządzenia zawsze będzie mieć pierwszeństwo przed tym ustawionym okresem.
- extraQueryParameters — ciąg do mapy ciągów niestandardowych parametrów zapytania dodanych do ciągu zapytania
type CommonDeviceCodeRequest = Omit<
BaseAuthRequest,
"tokenQueryParameters" | "tokenBodyParameters"
> & {
cancel?: boolean
deviceCodeCallback: (response: DeviceCodeResponse) => void
extraQueryParameters?: StringDict
timeout?: number
}