Interface IConfidentialClientApplication

Interface for the ConfidentialClientApplication class defining the public API signatures

Hierarchy

IConfidentialClientApplication

Implemented by

Index

Methods

SetAppTokenProvider acquireTokenByClientCredential acquireTokenByCode acquireTokenByRefreshToken acquireTokenByUsernamePassword acquireTokenOnBehalfOf acquireTokenSilent clearCache getAuthCodeUrl getLogger getTokenCache setLogger

Methods

SetAppTokenProvider

SetAppTokenProvider(provider): void
This extensibility point is meant for Azure SDK to enhance Managed Identity support
Parameters
- provider: IAppTokenProvider
Returns void
- Defined in msal-node/src/client/IConfidentialClientApplication.ts:71

acquireTokenByClientCredential

acquireTokenByClientCredential(request): Promise<null | AuthenticationResult>
Acquires tokens from the authority for the application (not for an end user)
Parameters
- request: ClientCredentialRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/IConfidentialClientApplication.ts:44

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/IConfidentialClientApplication.ts:29

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/IConfidentialClientApplication.ts:39

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/IConfidentialClientApplication.ts:54

acquireTokenOnBehalfOf

acquireTokenOnBehalfOf(request): Promise<null | AuthenticationResult>
Acquires tokens from the authority for the application
Parameters
- request: OnBehalfOfRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/IConfidentialClientApplication.ts:49

acquireTokenSilent

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

clearCache

clearCache(): void
Clear the cache

Returns void
- Defined in msal-node/src/client/IConfidentialClientApplication.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/IConfidentialClientApplication.ts:26

getLogger

getLogger(): Logger
Returns the logger instance

Returns Logger
- Defined in msal-node/src/client/IConfidentialClientApplication.ts:62

getTokenCache

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

Returns TokenCache
- Defined in msal-node/src/client/IConfidentialClientApplication.ts:59

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/IConfidentialClientApplication.ts:65

Generated using TypeDoc