DeviceCodeClient class

OAuth2.0-apparaatcodeclient

Uitbreiding
@azure/msal-common.BaseClient

Overgenomen eigenschappen

authority
logger

Methoden

acquireToken(CommonDeviceCodeRequest)

Hiermee haalt u apparaatcode op van het eindpunt van de apparaatcode, roept u terug naar het apparaatcode-antwoord en pollt u het tokeneindpunt om apparaatcode voor tokens uit te wisselen

createExtraQueryParameters(CommonDeviceCodeRequest)

Hiermee maakt u een querytekenreeks voor de aanvraag voor apparaatcode

Overgenomen methoden

createTokenQueryParameters(BaseAuthRequest)

Hiermee maakt u een querytekenreeks voor de /token-aanvraag

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

Verpakt sendPostRequestAsync met de benodigde preflight- en postflight-logica

updateAuthority(string, string)

Hiermee wordt het instantieobject van de client bijgewerkt. Eindpuntdetectie moet worden voltooid.

Constructordetails

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Parameters

configuration
@azure/msal-common.ClientConfiguration

Details van overgenomen eigenschap

authority

authority: Authority

Waarde van eigenschap

@azure/msal-common.Authority

Overgenomen van BaseClient.authority

logger

logger: Logger

Waarde van eigenschap

Overgenomen van BaseClient.logger

Methodedetails

acquireToken(CommonDeviceCodeRequest)

Hiermee haalt u apparaatcode op van het eindpunt van de apparaatcode, roept u terug naar het apparaatcode-antwoord en pollt u het tokeneindpunt om apparaatcode voor tokens uit te wisselen

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

Parameters

request
CommonDeviceCodeRequest

ontwikkelaar heeft CommonDeviceCodeRequest geleverd

Retouren

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Hiermee maakt u een querytekenreeks voor de aanvraag voor apparaatcode

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Parameters

request
CommonDeviceCodeRequest

ontwikkelaar heeft CommonDeviceCodeRequest geleverd

Retouren

string

Details overgenomen methode

createTokenQueryParameters(BaseAuthRequest)

Hiermee maakt u een querytekenreeks voor de /token-aanvraag

function createTokenQueryParameters(request: BaseAuthRequest): string

Parameters

request
BaseAuthRequest

Retouren

string

Overgenomen van BaseClient.createTokenQueryParameters

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

Verpakt sendPostRequestAsync met de benodigde preflight- en postflight-logica

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

Parameters

thumbprint
RequestThumbprint

Vingerafdruk aanvragen voor beperking

tokenEndpoint

string

Eindpunt om de POST naar

options
NetworkRequestOptions

Hoofdtekst en headers die moeten worden opgenomen in de POST-aanvraag

correlationId

string

CorrelationId voor telemetrie

Retouren

Promise<NetworkResponse<T>>

Overgenomen van BaseClient.sendPostRequest

updateAuthority(string, string)

Hiermee wordt het instantieobject van de client bijgewerkt. Eindpuntdetectie moet worden voltooid.

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

Parameters

cloudInstanceHostname

string

correlationId

string

Retouren

Promise<void>

Overgenomen van BaseClient.updateAuthority