DeviceCodeClient class

OAuth2.0 Enhetskodklient

Extends
@azure/msal-common.BaseClient

Ärvda egenskaper

authority
logger

Metoder

acquireToken(CommonDeviceCodeRequest)

Hämtar enhetskod från slutpunkten för enhetskod, anropar tillbaka till med enhetskodsvar och avsöker tokenslutpunkten för att utbyta enhetskod för token

createExtraQueryParameters(CommonDeviceCodeRequest)

Skapar frågesträng för enhetskodbegäran

Ärvda metoder

createTokenQueryParameters(BaseAuthRequest)

Skapar frågesträng för /token-begäran

sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)

Omsluter sendPostRequestAsync med nödvändig preflight- och postflight-logik

updateAuthority(string, string)

Uppdaterar utfärdarobjektet för klienten. Slutpunktsidentifieringen måste slutföras.

Konstruktorinformation

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Parametrar

configuration
@azure/msal-common.ClientConfiguration

Information om ärvda egenskaper

authority

authority: Authority

Egenskapsvärde

@azure/msal-common.Authority

Ärvd från BaseClient.authority

logger

logger: Logger

Egenskapsvärde

Ärvd från BaseClient.logger

Metodinformation

acquireToken(CommonDeviceCodeRequest)

Hämtar enhetskod från slutpunkten för enhetskod, anropar tillbaka till med enhetskodsvar och avsöker tokenslutpunkten för att utbyta enhetskod för token

function acquireToken(request: CommonDeviceCodeRequest): Promise<null | AuthenticationResult>

Parametrar

request
CommonDeviceCodeRequest

developer provided CommonDeviceCodeRequest

Returer

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Skapar frågesträng för enhetskodbegäran

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Parametrar

request
CommonDeviceCodeRequest

developer provided CommonDeviceCodeRequest

Returer

string

Ärvd metodinformation

createTokenQueryParameters(BaseAuthRequest)

Skapar frågesträng för /token-begäran

function createTokenQueryParameters(request: BaseAuthRequest): string

Parametrar

request
BaseAuthRequest

Returer

string

Ärvd från BaseClient.createTokenQueryParameters

sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)

Omsluter sendPostRequestAsync med nödvändig preflight- och postflight-logik

function sendPostRequest<T>(thumbprint: RequestThumbprint, tokenEndpoint: string, options: NetworkRequestOptions, correlationId: string): Promise<NetworkResponse<T>>

Parametrar

thumbprint
RequestThumbprint

Begära tumavtryck för begränsning

tokenEndpoint

string

Slutpunkt för att göra POST till

options
NetworkRequestOptions

Brödtext och rubriker som ska inkluderas i POST-begäran

correlationId

string

CorrelationId för telemetri

Returer

Promise<NetworkResponse<T>>

Ärvd från BaseClient.sendPostRequest

updateAuthority(string, string)

Uppdaterar utfärdarobjektet för klienten. Slutpunktsidentifieringen måste slutföras.

function updateAuthority(cloudInstanceHostname: string, correlationId: string): Promise<void>

Parametrar

cloudInstanceHostname

string

correlationId

string

Returer

Promise<void>

Ärvd från BaseClient.updateAuthority