DeviceCodeClient class

Paket:

@azure/msal-node

Klien kode perangkat OAuth2.0

Memperluas

@azure/msal-common.BaseClient

Konstruktor

DeviceCodeClient(ClientConfiguration)

Properti yang Diwariskan

authority
logger

Metode

acquireToken(CommonDeviceCodeRequest)	Mendapatkan kode perangkat dari titik akhir kode perangkat, panggilan kembali dengan respons kode perangkat, dan titik akhir token polling untuk bertukar kode perangkat dengan token
createExtraQueryParameters(CommonDeviceCodeRequest)	Membuat string kueri untuk permintaan kode perangkat

Metode yang Diwarisi

createTokenQueryParameters(BaseAuthRequest)	Membuat string kueri untuk permintaan /token
sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)	Bungkus sendPostRequestAsync dengan logika preflight dan postflight yang diperlukan
updateAuthority(string, string)	Memperbarui objek otoritas klien. Penemuan titik akhir harus diselesaikan.

Detail Konstruktor

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Parameter

configuration

@azure/msal-common.ClientConfiguration

Detail Properti yang Diwariskan

authority

authority: Authority

Nilai Properti

@azure/msal-common.Authority

Diwariskan Dari BaseClient.authority

logger

logger: Logger

Nilai Properti

Logger

Diwariskan Dari BaseClient.logger

Detail Metode

acquireToken(CommonDeviceCodeRequest)

Mendapatkan kode perangkat dari titik akhir kode perangkat, panggilan kembali dengan respons kode perangkat, dan titik akhir token polling untuk bertukar kode perangkat dengan token

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

Parameter

request

CommonDeviceCodeRequest

pengembang menyediakan CommonDeviceCodeRequest

Mengembalikan

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Membuat string kueri untuk permintaan kode perangkat

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Parameter

request

CommonDeviceCodeRequest

pengembang menyediakan CommonDeviceCodeRequest

Mengembalikan

string

Detail Metode yang Diwarisi

createTokenQueryParameters(BaseAuthRequest)

Membuat string kueri untuk permintaan /token

function createTokenQueryParameters(request: BaseAuthRequest): string

Parameter

request

BaseAuthRequest

Mengembalikan

string

Diwariskan Dari BaseClient.createTokenQueryParameters

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

Bungkus sendPostRequestAsync dengan logika preflight dan postflight yang diperlukan

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

Parameter

thumbprint

RequestThumbprint

Meminta thumbprint untuk pembatasan

tokenEndpoint

string

Titik akhir untuk membuat POST ke

options

NetworkRequestOptions

Isi dan Header untuk disertakan pada permintaan POST

correlationId

string

CorrelationId untuk telemetri

Mengembalikan

Promise<NetworkResponse<T>>

Diwariskan Dari BaseClient.sendPostRequest

updateAuthority(string, string)

Memperbarui objek otoritas klien. Penemuan titik akhir harus diselesaikan.

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

Parameter

cloudInstanceHostname

string

correlationId

string

Mengembalikan

Promise<void>

Diwariskan Dari BaseClient.updateAuthority