CommonDeviceCodeRequest type

Balíček:
@azure/msal-common

Parametry toku kódu zařízení Oauth2

  • scopes – Pole oborů, ke které aplikace žádá o přístup.
  • autorita: – adresa URL autority, služba tokenů zabezpečení (STS), ze které služba MSAL získá tokeny. Pokud je u objektu klientské aplikace nastavená autorita, tato hodnota se přepíše. Přepsání hodnoty způsobí, že se ověření autority provede pokaždé. Pokud se pro všechny požadavky použije stejná autorita, nastavte místo požadavků objekt aplikace.
  • correlationId – Jedinečná sada GUID pro každý požadavek pro trasování koncového požadavku pro účely telemetrie.
  • deviceCodeCallback – Zpětné volání obsahující odpověď kódu zařízení. Koncovému uživateli by se měla zobrazit zpráva. Koncový uživatel pak může přejít na verification_uri, zadat user_code a vstupní přihlašovací údaje.
  • cancel – Logická hodnota pro zrušení dotazování koncového bodu kódu zařízení. Zatímco se uživatel ověřuje na samostatném zařízení, MSAL dotazuje koncový bod tokenu služby tokenů zabezpečení na interval zadaný v odpovědi kódu zařízení (obvykle 15 minut). Pokud chcete ukončit dotazování a zrušit požadavek, nastavte cancel=true.
  • resourceRequestMethod – typ požadavku HTTP použitý k vyžádání dat z prostředku (tj. GET, POST atd.). Používá se pro toky proti vlastnictví.
  • resourceRequestUri – identifikátor URI, pro který se token použije. Používá se pro toky proti vlastnictví.
  • časový limit – doba časového limitu v sekundách, během které uživatel explicitně nakonfiguruje dotazování koncového bodu kódu zařízení. Na konci tohoto období; za předpokladu, že kód zařízení ještě nevypršel; Dotazování kódu zařízení se zastaví a žádost se zruší. Okno vypršení platnosti kódu zařízení bude mít vždy přednost před tímto nastaveným obdobím.
  • extraQueryParameters – string to string map of custom query parameters added to the query string
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}