DeviceCodeClient class

Пакет:

@azure/msal-node

Клиент кода устройства OAuth2.0

Extends

@azure/msal-common.BaseClient

Конструкторы

DeviceCodeClient(ClientConfiguration)

Унаследованные свойства

authority
logger

Методы

acquireToken(CommonDeviceCodeRequest)	Возвращает код устройства из конечной точки кода устройства, возвращает ответ на код устройства и опрашивает конечную точку маркера для обмена кодом устройства на маркеры
createExtraQueryParameters(CommonDeviceCodeRequest)	Создает строку запроса на код устройства

Наследуемые методы

createTokenQueryParameters(BaseAuthRequest)	Создает строку запроса для запроса /token
sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)	Оболочки sendPostRequestAsync с необходимой предварительной и последующей логикой
updateAuthority(string, string)	Обновляет объект центра клиента. Обнаружение конечных точек должно быть завершено.

Сведения о конструкторе

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Параметры

configuration

@azure/msal-common.ClientConfiguration

Сведения об унаследованном свойстве

authority

authority: Authority

Значение свойства

@azure/msal-common.Authority

Наследуется от BaseClient.authority

logger

logger: Logger

Значение свойства

Logger

Наследуется от BaseClient.logger

Сведения о методе

acquireToken(CommonDeviceCodeRequest)

Возвращает код устройства из конечной точки кода устройства, возвращает ответ на код устройства и опрашивает конечную точку маркера для обмена кодом устройства на маркеры

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

Параметры

request

CommonDeviceCodeRequest

разработчик предоставил CommonDeviceCodeRequest

Возвращаемое значение

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Создает строку запроса на код устройства

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Параметры

request

CommonDeviceCodeRequest

разработчик предоставил CommonDeviceCodeRequest

Возвращаемое значение

string

Сведения о наследуемом методе

createTokenQueryParameters(BaseAuthRequest)

Создает строку запроса для запроса /token

function createTokenQueryParameters(request: BaseAuthRequest): string

Параметры

request

BaseAuthRequest

Возвращаемое значение

string

Наследуется от BaseClient.createTokenQueryParameters

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

Оболочки sendPostRequestAsync с необходимой предварительной и последующей логикой

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

Параметры

thumbprint

RequestThumbprint

Отпечаток запроса для регулирования

tokenEndpoint

string

Конечная точка для создания post

options

NetworkRequestOptions

Текст и заголовки для включения в запрос POST

correlationId

string

CorrelationId для телеметрии

Возвращаемое значение

Promise<NetworkResponse<T>>

Наследуется от BaseClient.sendPostRequest

updateAuthority(string, string)

Обновляет объект центра клиента. Обнаружение конечных точек должно быть завершено.

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

Параметры

cloudInstanceHostname

string

correlationId

string

Возвращаемое значение

Promise<void>

Наследуется от BaseClient.updateAuthority