ClientApplication class

Základní abstraktní třída pro všechny ClientApplications – veřejné a důvěrné

Metody

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Získá token výměnou autorizačního kódu přijatého z prvního kroku toku autorizačního kódu OAuth2.0.

getAuthCodeUrl(AuthorizationCodeUrlRequest) lze použít k vytvoření adresy URL pro první krok toku autorizačního kódu OAuth2.0. Ujistěte se, že hodnoty pro redirectUri a obory v AuthorizationCodeUrlRequest a AuthorizationCodeRequest jsou stejné.

acquireTokenByRefreshToken(RefreshTokenRequest)

Získá token výměnou obnovovacího tokenu poskytnutého pro novou sadu tokenů.

Toto rozhraní API je k dispozici pouze pro scénáře, ve kterých chcete migrovat z knihovny ADAL na knihovnu MSAL. V opačném případě se doporučuje používat acquireTokenSilent() pro tiché scénáře. Při použití acquireTokenSilent()bude msAL automaticky zpracovávat ukládání do mezipaměti a aktualizace tokenů.

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Získá tokeny s udělením hesla výměnou uživatelského jména a hesla klientských aplikací pro přihlašovací údaje.

Nejnovější osvědčený postup zabezpečení OAuth 2.0 v současné době zakáže udělení hesla zcela. Další podrobnosti o tomto doporučení najdete v https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 dokumentaci a doporučeních Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

acquireTokenSilent(SilentFlowRequest)

Získá token bezobslužně, když uživatel určí účet, pro který je token požadován.

Toto rozhraní API očekává, že uživatel poskytne objekt účtu a vyhledá v mezipaměti token, pokud je k dispozici. K dispozici je také volitelná logická hodnota forceRefresh, která může uživatel odeslat a obejít mezipaměť pro access_token a id_token. V případě, že vypršela platnost refresh_token nebo nebyla nalezena, vyvolá se chyba a pokyny jsou určené pro volání jakéhokoli interaktivního rozhraní API pro získání tokenu (např. acquireTokenByCode()).

clearCache()

Vymazání mezipaměti

getAuthCodeUrl(AuthorizationUrlRequest)

Vytvoří adresu URL žádosti o autorizaci, která uživateli umožní zadat přihlašovací údaje a vyjádřit souhlas s aplikací. Adresa URL cílí na koncový bod /authorize autority nakonfigurované v objektu aplikace.

Jakmile uživatel zadá své přihlašovací údaje a souhlas, autorita odešle odpověď na identifikátor URI přesměrování odeslaný v požadavku a měl by obsahovat autorizační kód, který pak lze použít k získání tokenů prostřednictvím acquireTokenByCode(AuthorizationCodeRequest).

getLogger()

Vrátí instanci protokolovacího nástroje.

getTokenCache()

Získá mezipaměť tokenů pro aplikaci.

setLogger(Logger)

Nahradí výchozí protokolovací sadu v konfiguracích novým protokolovacím nástrojem novými konfiguracemi.

Podrobnosti metody

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

Získá token výměnou autorizačního kódu přijatého z prvního kroku toku autorizačního kódu OAuth2.0.

getAuthCodeUrl(AuthorizationCodeUrlRequest) lze použít k vytvoření adresy URL pro první krok toku autorizačního kódu OAuth2.0. Ujistěte se, že hodnoty pro redirectUri a obory v AuthorizationCodeUrlRequest a AuthorizationCodeRequest jsou stejné.

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

Parametry

authCodePayLoad
AuthorizationCodePayload

Návraty

acquireTokenByRefreshToken(RefreshTokenRequest)

Získá token výměnou obnovovacího tokenu poskytnutého pro novou sadu tokenů.

Toto rozhraní API je k dispozici pouze pro scénáře, ve kterých chcete migrovat z knihovny ADAL na knihovnu MSAL. V opačném případě se doporučuje používat acquireTokenSilent() pro tiché scénáře. Při použití acquireTokenSilent()bude msAL automaticky zpracovávat ukládání do mezipaměti a aktualizace tokenů.

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

Parametry

Návraty

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Upozornění

Toto rozhraní API je teď zastaralé.

  • Use a more secure flow instead

Získá tokeny s udělením hesla výměnou uživatelského jména a hesla klientských aplikací pro přihlašovací údaje.

Nejnovější osvědčený postup zabezpečení OAuth 2.0 v současné době zakáže udělení hesla zcela. Další podrobnosti o tomto doporučení najdete v https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 dokumentaci a doporučeních Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

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

Parametry

request
UsernamePasswordRequest

UsenamePasswordRequest

Návraty

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

Získá token bezobslužně, když uživatel určí účet, pro který je token požadován.

Toto rozhraní API očekává, že uživatel poskytne objekt účtu a vyhledá v mezipaměti token, pokud je k dispozici. K dispozici je také volitelná logická hodnota forceRefresh, která může uživatel odeslat a obejít mezipaměť pro access_token a id_token. V případě, že vypršela platnost refresh_token nebo nebyla nalezena, vyvolá se chyba a pokyny jsou určené pro volání jakéhokoli interaktivního rozhraní API pro získání tokenu (např. acquireTokenByCode()).

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

Parametry

Návraty

clearCache()

Vymazání mezipaměti

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Vytvoří adresu URL žádosti o autorizaci, která uživateli umožní zadat přihlašovací údaje a vyjádřit souhlas s aplikací. Adresa URL cílí na koncový bod /authorize autority nakonfigurované v objektu aplikace.

Jakmile uživatel zadá své přihlašovací údaje a souhlas, autorita odešle odpověď na identifikátor URI přesměrování odeslaný v požadavku a měl by obsahovat autorizační kód, který pak lze použít k získání tokenů prostřednictvím acquireTokenByCode(AuthorizationCodeRequest).

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

Parametry

Návraty

Promise<string>

getLogger()

Vrátí instanci protokolovacího nástroje.

function getLogger(): Logger

Návraty

getTokenCache()

Získá mezipaměť tokenů pro aplikaci.

function getTokenCache(): TokenCache

Návraty

setLogger(Logger)

Nahradí výchozí protokolovací sadu v konfiguracích novým protokolovacím nástrojem novými konfiguracemi.

function setLogger(logger: Logger)

Parametry

logger
Logger

Instance loggeru