DeviceCodeClient class

Pakiet:

@azure/msal-node

Klient kodu urządzenia OAuth2.0

Rozszerzenie

@azure/msal-common.BaseClient

Konstruktory

DeviceCodeClient(ClientConfiguration)

Właściwości dziedziczone

authority
logger

Metody

acquireToken(CommonDeviceCodeRequest)	Pobiera kod urządzenia z punktu końcowego kodu urządzenia, wywołuje z powrotem odpowiedź kodu urządzenia i sonduje punkt końcowy tokenu w celu wymiany kodu urządzenia dla tokenów
createExtraQueryParameters(CommonDeviceCodeRequest)	Tworzy ciąg zapytania dla żądania kodu urządzenia

Metody dziedziczone

createTokenQueryParameters(BaseAuthRequest)	Tworzy ciąg zapytania dla żądania /token
sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)	Zawija polecenia sendPostRequestAsync z wymaganą logiką wstępną i postflight
updateAuthority(string, string)	Aktualizuje obiekt urzędu klienta. Odnajdywanie punktów końcowych musi zostać ukończone.

Szczegóły konstruktora

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Parametry

configuration

@azure/msal-common.ClientConfiguration

Szczegóły właściwości dziedziczonej

authority

authority: Authority

Wartość właściwości

@azure/msal-common.Authority

Dziedziczone z BaseClient.authority

logger

logger: Logger

Wartość właściwości

Logger

Dziedziczone z BaseClient.logger

Szczegóły metody

acquireToken(CommonDeviceCodeRequest)

Pobiera kod urządzenia z punktu końcowego kodu urządzenia, wywołuje z powrotem odpowiedź kodu urządzenia i sonduje punkt końcowy tokenu w celu wymiany kodu urządzenia dla tokenów

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

Parametry

request

CommonDeviceCodeRequest

udostępniony przez dewelopera CommonDeviceCodeRequest

Zwraca

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Tworzy ciąg zapytania dla żądania kodu urządzenia

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Parametry

request

CommonDeviceCodeRequest

udostępniony przez dewelopera CommonDeviceCodeRequest

Zwraca

string

Szczegóły metody dziedziczonej

createTokenQueryParameters(BaseAuthRequest)

Tworzy ciąg zapytania dla żądania /token

function createTokenQueryParameters(request: BaseAuthRequest): string

Parametry

request

BaseAuthRequest

Zwraca

string

Dziedziczone z BaseClient.createTokenQueryParameters

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

Zawija polecenia sendPostRequestAsync z wymaganą logiką wstępną i postflight

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

Parametry

thumbprint

RequestThumbprint

Żądanie odcisku palca dla ograniczania przepustowości

tokenEndpoint

string

Punkt końcowy umożliwiający wprowadzenie postu do

options

NetworkRequestOptions

Treść i nagłówki do uwzględnienia w żądaniu POST

correlationId

string

CorrelationId dla telemetrii

Zwraca

Promise<NetworkResponse<T>>

Dziedziczone z BaseClient.sendPostRequest

updateAuthority(string, string)

Aktualizuje obiekt urzędu klienta. Odnajdywanie punktów końcowych musi zostać ukończone.

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

Parametry

cloudInstanceHostname

string

correlationId

string

Zwraca

Promise<void>

Dziedziczone z BaseClient.updateAuthority