Class UsernamePasswordClient

Oauth2.0 Password grant client Note: We are only supporting public clients for password grant and for purely testing purposes

Deprecated

Use a more secure flow instead

Hierarchy

BaseClient
- UsernamePasswordClient

Index

Constructors

Properties

authority logger

Methods

acquireToken createTokenQueryParameters sendPostRequest updateAuthority

Constructors

constructor

new UsernamePasswordClient(configuration): UsernamePasswordClient
Parameters
- configuration: ClientConfiguration
Returns UsernamePasswordClient
Overrides BaseClient.constructor
- Defined in msal-node/src/client/UsernamePasswordClient.ts:35

Properties

authority

authority: Authority

logger

logger: Logger

Methods

acquireToken

acquireToken(request): Promise<null | AuthenticationResult>
API to acquire a token by passing the username and password to the service in exchage of credentials password_grant
Parameters
- request: CommonUsernamePasswordRequest
  
  CommonUsernamePasswordRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/UsernamePasswordClient.ts:44

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:57

sendPostRequest

sendPostRequest<T>(thumbprint, tokenEndpoint, options, correlationId): Promise<NetworkResponse<T>>
Wraps sendPostRequestAsync with necessary preflight and postflight logic
Type Parameters
- T extends ServerAuthorizationTokenResponse
Parameters
- thumbprint: RequestThumbprint
  
  Request thumbprint for throttling
- tokenEndpoint: string
  
  Endpoint to make the POST to
- options: NetworkRequestOptions
  
  Body and Headers to include on the POST request
- correlationId: string
  
  CorrelationId for telemetry
Returns Promise<NetworkResponse<T>>
Inherited from BaseClient.sendPostRequest
- Defined in msal-common/dist/client/BaseClient.d.ts:47

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:52

Generated using TypeDoc