Class ClientCredentialClient

OAuth2.0 client credential grant

Hierarchy

BaseClient
- ClientCredentialClient

Index

Constructors

Properties

authority logger

Methods

acquireToken createTokenQueryParameters getCachedAuthenticationResult updateAuthority

Constructors

constructor

new ClientCredentialClient(configuration, appTokenProvider?): ClientCredentialClient
Parameters
- configuration: ClientConfiguration
- Optional appTokenProvider: IAppTokenProvider
Returns ClientCredentialClient
Overrides BaseClient.constructor
- Defined in msal-node/src/client/ClientCredentialClient.ts:49

Properties

authority

authority: Authority

logger

logger: Logger

Methods

acquireToken

acquireToken(request): Promise<null | AuthenticationResult>
Public API to acquire a token with ClientCredential Flow for Confidential clients
Parameters
- request: CommonClientCredentialRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/ClientCredentialClient.ts:61

createTokenQueryParameters

createTokenQueryParameters(request): string
Creates query string for the /token request
Parameters
- request: BaseAuthRequest
Returns string
Inherited from BaseClient.createTokenQueryParameters
- Defined in msal-common/dist/client/BaseClient.d.ts:50

getCachedAuthenticationResult

getCachedAuthenticationResult(request, config, cryptoUtils, authority, cacheManager, serverTelemetryManager?): Promise<[null | AuthenticationResult, CacheOutcome]>
looks up cache if the tokens are cached already
Parameters
- request: CommonClientCredentialRequest
- config: ClientConfiguration | ManagedIdentityConfiguration
- cryptoUtils: ICrypto
- authority: Authority
- cacheManager: CacheManager
- Optional serverTelemetryManager: null | ServerTelemetryManager
Returns Promise<[null | AuthenticationResult, CacheOutcome]>
- Defined in msal-node/src/client/ClientCredentialClient.ts:104

updateAuthority

updateAuthority(cloudInstanceHostname, correlationId): Promise<void>
Updates the authority object of the client. Endpoint discovery must be completed.
Parameters
- cloudInstanceHostname: string
- correlationId: string
Returns Promise<void>
Inherited from BaseClient.updateAuthority
- Defined in msal-common/dist/client/BaseClient.d.ts:45

Generated using TypeDoc