Interface IPublicClientApplication

Interface for the PublicClientApplication class defining the public API signatures

Hierarchy

IPublicClientApplication

Implemented by

Index

Methods

acquireTokenByCode acquireTokenByDeviceCode acquireTokenByRefreshToken acquireTokenByUsernamePassword acquireTokenInteractive acquireTokenSilent clearCache getAllAccounts getAuthCodeUrl getLogger getTokenCache setLogger signOut

Methods

acquireTokenByCode

acquireTokenByCode(request): Promise<AuthenticationResult>
Acquires a token by exchanging the authorization code received from the first step of OAuth 2.0 Authorization Code Flow
Parameters
- request: AuthorizationCodeRequest
Returns Promise<AuthenticationResult>
- Defined in msal-node/src/client/IPublicClientApplication.ts:26

acquireTokenByDeviceCode

acquireTokenByDeviceCode(request): Promise<null | AuthenticationResult>
Acquires a token from the authority using OAuth2.0 device code flow
Parameters
- request: DeviceCodeRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/IPublicClientApplication.ts:46

acquireTokenByRefreshToken

acquireTokenByRefreshToken(request): Promise<null | AuthenticationResult>
Acquires a token by exchanging the refresh token provided for a new set of tokens
Parameters
- request: RefreshTokenRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/IPublicClientApplication.ts:41

acquireTokenByUsernamePassword

acquireTokenByUsernamePassword(request): Promise<null | AuthenticationResult>
Acquires tokens with password grant by exchanging client applications username and password for credentials
Parameters
- request: UsernamePasswordRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/IPublicClientApplication.ts:51

acquireTokenInteractive

acquireTokenInteractive(request): Promise<AuthenticationResult>
Acquires a token interactively
Parameters
- request: InteractiveRequest
Returns Promise<AuthenticationResult>
- Defined in msal-node/src/client/IPublicClientApplication.ts:31

acquireTokenSilent

acquireTokenSilent(request): Promise<AuthenticationResult>
Acquires a token silently when a user specifies the account the token is requested for
Parameters
- request: SilentFlowRequest
Returns Promise<AuthenticationResult>
- Defined in msal-node/src/client/IPublicClientApplication.ts:36

clearCache

clearCache(): void
Clear the cache

Returns void
- Defined in msal-node/src/client/IPublicClientApplication.ts:65

getAllAccounts

getAllAccounts(): Promise<AccountInfo[]>
Gets all cached accounts

Returns Promise<AccountInfo[]>
- Defined in msal-node/src/client/IPublicClientApplication.ts:68

getAuthCodeUrl

getAuthCodeUrl(request): Promise<string>
Creates the URL of the authorization request
Parameters
- request: AuthorizationUrlRequest
Returns Promise<string>
- Defined in msal-node/src/client/IPublicClientApplication.ts:23

getLogger

getLogger(): Logger
Returns the logger instance

Returns Logger
- Defined in msal-node/src/client/IPublicClientApplication.ts:59

getTokenCache

getTokenCache(): TokenCache
Gets the token cache for the application

Returns TokenCache
- Defined in msal-node/src/client/IPublicClientApplication.ts:56

setLogger

setLogger(logger): void
Replaces the default logger set in configurations with new Logger with new configurations
Parameters
- logger: Logger
Returns void
- Defined in msal-node/src/client/IPublicClientApplication.ts:62

signOut

signOut(request): Promise<void>
Removes cache artifacts associated with the given account
Parameters
- request: SignOutRequest
Returns Promise<void>
- Defined in msal-node/src/client/IPublicClientApplication.ts:71

Generated using TypeDoc