Class DeviceCodeClient

OAuth2.0 Device code client

Hierarchy

BaseClient
- DeviceCodeClient

Index

Constructors

Properties

authority logger

Methods

acquireToken createExtraQueryParameters createTokenQueryParameters updateAuthority

Constructors

constructor

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

Properties

authority

authority: Authority

logger

logger: Logger

Methods

acquireToken

acquireToken(request): Promise<null | AuthenticationResult>
Gets device code from device code endpoint, calls back to with device code response, and polls token endpoint to exchange device code for tokens
Parameters
- request: CommonDeviceCodeRequest
Returns Promise<null | AuthenticationResult>
- Defined in msal-node/src/client/DeviceCodeClient.ts:41

createExtraQueryParameters

createExtraQueryParameters(request): string
Creates query string for the device code request
Parameters
- request: CommonDeviceCodeRequest
Returns string
- Defined in msal-node/src/client/DeviceCodeClient.ts:109

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

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