IPublicClientApplication interface

Balíček:

@azure/msal-node

Rozhraní pro třídu PublicClientApplication definující podpisy veřejného rozhraní API

Metody

acquireTokenByCode(AuthorizationCodeRequest)	Získá token výměnou autorizačního kódu přijatého z prvního kroku toku autorizačního kódu OAuth 2.0.
acquireTokenByDeviceCode(DeviceCodeRequest)	Získá token od autority pomocí toku kódu zařízení OAuth2.0.
acquireTokenByRefreshToken(RefreshTokenRequest)	Získá token výměnou obnovovacího tokenu poskytnutého pro novou sadu 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.
acquireTokenInteractive(InteractiveRequest)	Interaktivně získá token.
acquireTokenSilent(SilentFlowRequest)	Získá token bezobslužně, když uživatel určí účet, pro který se token požaduje.
clearCache()	Vymazání mezipaměti
getAllAccounts()	Získá všechny účty uložené v mezipaměti.
getAuthCodeUrl(AuthorizationUrlRequest)	Vytvoří adresu URL žádosti o autorizaci.
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.
signOut(SignOutRequest)	Odebere artefakty mezipaměti přidružené k danému účtu.

Podrobnosti metody

acquireTokenByCode(AuthorizationCodeRequest)

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

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

Parametry

request

AuthorizationCodeRequest

Návraty

Promise<AuthenticationResult>

acquireTokenByDeviceCode(DeviceCodeRequest)

Získá token od autority pomocí toku kódu zařízení OAuth2.0.

function acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<null | AuthenticationResult>

Parametry

request

DeviceCodeRequest

Návraty

Promise<null | AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

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

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

Parametry

request

RefreshTokenRequest

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.

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

Parametry

request

UsernamePasswordRequest

Návraty

Promise<null | AuthenticationResult>

acquireTokenInteractive(InteractiveRequest)

Interaktivně získá token.

function acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult>

Parametry

request

InteractiveRequest

Návraty

Promise<AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

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

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

Parametry

request

SilentFlowRequest

Návraty

Promise<AuthenticationResult>

clearCache()

Vymazání mezipaměti

function clearCache()

getAllAccounts()

Získá všechny účty uložené v mezipaměti.

function getAllAccounts(): Promise<AccountInfo[]>

Návraty

Promise<AccountInfo[]>

getAuthCodeUrl(AuthorizationUrlRequest)

Vytvoří adresu URL žádosti o autorizaci.

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

Parametry

request

AuthorizationUrlRequest

Návraty

Promise<string>

getLogger()

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

function getLogger(): Logger

Návraty

Logger

getTokenCache()

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

function getTokenCache(): TokenCache

Návraty

TokenCache

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

signOut(SignOutRequest)

Odebere artefakty mezipaměti přidružené k danému účtu.

function signOut(request: SignOutRequest): Promise<void>

Parametry

request

SignOutRequest

Návraty

Promise<void>