ClientApplication class

Az összes ClientApplication alapszintű absztrakt osztálya – nyilvános és bizalmas

Metódusok

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Jogkivonatot szerez be az OAuth2.0 engedélyezési kód folyamatának első lépésétől kapott engedélyezési kód cseréjével.

getAuthCodeUrl(AuthorizationCodeUrlRequest) az OAuth2.0 engedélyezési kód folyamatának első lépéséhez használható az URL-cím létrehozásához. Győződjön meg arról, hogy az AuthorizationCodeUrlRequest és az AuthorizationCodeRequest átirányításiuri és hatóköreinek értékei megegyeznek.

acquireTokenByRefreshToken(RefreshTokenRequest)

A jogkivonatot az új jogkivonatok frissítési jogkivonatának cseréjével szerzi be.

Ez az API csak olyan forgatókönyvekhez érhető el, ahol ADAL-ról MSAL-ra szeretne migrálni. Ellenkező esetben ajánlott csendes forgatókönyvekhez használni acquireTokenSilent() . A használat során acquireTokenSilent()az MSAL automatikusan kezeli a jogkivonatok gyorsítótárazását és frissítését.

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Jogkivonatokat szerez be jelszó megadásával az ügyfélalkalmazások felhasználónév és jelszó cseréjével a hitelesítő adatokhoz

A legújabb OAuth 2.0 biztonsági ajánlott eljárás teljes mértékben letiltja a jelszó megadását. A javaslatról https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 további információt Microsoft dokumentációjában és javaslatában talál:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

acquireTokenSilent(SilentFlowRequest)

Csendesen beolvas egy jogkivonatot, amikor egy felhasználó megadja azt a fiókot, amelyhez a jogkivonatot kérik.

Ez az API elvárja a felhasználótól, hogy adjon meg egy fiókobjektumot, és vizsgálja meg a gyorsítótárat, hogy lekérje a jogkivonatot, ha van ilyen. Van egy opcionális "forceRefresh" logikai is, amelyet a felhasználó küldhet, hogy megkerülje access_token és id_token gyorsítótárát. Abban az esetben, ha a refresh_token lejárt vagy nem található, hibaüzenet jelenik meg, és az útmutató az, hogy a felhasználó meghívjon bármilyen interaktív jogkivonat-beszerzési API-t (például: acquireTokenByCode()).

clearCache()

A gyorsítótár törlése

getAuthCodeUrl(AuthorizationUrlRequest)

Létrehozza az engedélyezési kérelem URL-címét, lehetővé téve a felhasználó számára a hitelesítő adatok megadását és az alkalmazáshoz való hozzájárulást. Az URL az alkalmazásobjektumban konfigurált szolgáltató /engedélyezési végpontját célozza meg.

Miután a felhasználó megadta a hitelesítő adatait és beleegyezéseit, a szolgáltató választ küld a kérelemben küldött átirányítási URI-nak, és tartalmaznia kell egy engedélyezési kódot, amely ezután a jogkivonatok acquireTokenByCode(AuthorizationCodeRequest)beszerzésére használható.

getLogger()

A naplózópéldányt adja vissza

getTokenCache()

Lekéri az alkalmazás jogkivonat-gyorsítótárát.

setLogger(Logger)

A konfigurációkban beállított alapértelmezett naplózó lecserélése új naplózóra új konfigurációkra

Metódus adatai

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Jogkivonatot szerez be az OAuth2.0 engedélyezési kód folyamatának első lépésétől kapott engedélyezési kód cseréjével.

getAuthCodeUrl(AuthorizationCodeUrlRequest) az OAuth2.0 engedélyezési kód folyamatának első lépéséhez használható az URL-cím létrehozásához. Győződjön meg arról, hogy az AuthorizationCodeUrlRequest és az AuthorizationCodeRequest átirányításiuri és hatóköreinek értékei megegyeznek.

function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>

Paraméterek

authCodePayLoad
AuthorizationCodePayload

Válaszok

acquireTokenByRefreshToken(RefreshTokenRequest)

A jogkivonatot az új jogkivonatok frissítési jogkivonatának cseréjével szerzi be.

Ez az API csak olyan forgatókönyvekhez érhető el, ahol ADAL-ról MSAL-ra szeretne migrálni. Ellenkező esetben ajánlott csendes forgatókönyvekhez használni acquireTokenSilent() . A használat során acquireTokenSilent()az MSAL automatikusan kezeli a jogkivonatok gyorsítótárazását és frissítését.

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

Paraméterek

Válaszok

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Figyelmeztetés

Ez az API már elavult.

  • Use a more secure flow instead

Jogkivonatokat szerez be jelszó megadásával az ügyfélalkalmazások felhasználónév és jelszó cseréjével a hitelesítő adatokhoz

A legújabb OAuth 2.0 biztonsági ajánlott eljárás teljes mértékben letiltja a jelszó megadását. A javaslatról https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 további információt Microsoft dokumentációjában és javaslatában talál:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

Paraméterek

request
UsernamePasswordRequest

UsenamePasswordRequest

Válaszok

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Csendesen beolvas egy jogkivonatot, amikor egy felhasználó megadja azt a fiókot, amelyhez a jogkivonatot kérik.

Ez az API elvárja a felhasználótól, hogy adjon meg egy fiókobjektumot, és vizsgálja meg a gyorsítótárat, hogy lekérje a jogkivonatot, ha van ilyen. Van egy opcionális "forceRefresh" logikai is, amelyet a felhasználó küldhet, hogy megkerülje access_token és id_token gyorsítótárát. Abban az esetben, ha a refresh_token lejárt vagy nem található, hibaüzenet jelenik meg, és az útmutató az, hogy a felhasználó meghívjon bármilyen interaktív jogkivonat-beszerzési API-t (például: acquireTokenByCode()).

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

Paraméterek

Válaszok

clearCache()

A gyorsítótár törlése

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Létrehozza az engedélyezési kérelem URL-címét, lehetővé téve a felhasználó számára a hitelesítő adatok megadását és az alkalmazáshoz való hozzájárulást. Az URL az alkalmazásobjektumban konfigurált szolgáltató /engedélyezési végpontját célozza meg.

Miután a felhasználó megadta a hitelesítő adatait és beleegyezéseit, a szolgáltató választ küld a kérelemben küldött átirányítási URI-nak, és tartalmaznia kell egy engedélyezési kódot, amely ezután a jogkivonatok acquireTokenByCode(AuthorizationCodeRequest)beszerzésére használható.

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

Paraméterek

Válaszok

Promise<string>

getLogger()

A naplózópéldányt adja vissza

function getLogger(): Logger

Válaszok

getTokenCache()

Lekéri az alkalmazás jogkivonat-gyorsítótárát.

function getTokenCache(): TokenCache

Válaszok

setLogger(Logger)

A konfigurációkban beállított alapértelmezett naplózó lecserélése új naplózóra új konfigurációkra

function setLogger(logger: Logger)

Paraméterek

logger
Logger

Naplózópéldány