DeviceCodeClient class

Cliente de código de dispositivo OAuth2.0

Extends
@azure/msal-common.BaseClient

Propriedades Herdadas

authority
logger

Métodos

acquireToken(CommonDeviceCodeRequest)

Obtém o código do dispositivo a partir do endpoint do código do dispositivo, liga de volta com a resposta do código do dispositivo e questiona o endpoint do token para trocar código do dispositivo por tokens

createExtraQueryParameters(CommonDeviceCodeRequest)

Cria uma cadeia de consulta para o pedido de código do dispositivo

Métodos Herdados

createTokenQueryParameters(BaseAuthRequest)

Cria uma cadeia de consulta para o pedido /token

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

Envolve o sendPostRequestAsync com a lógica necessária de pré-voo e pós-voo

updateAuthority(string, string)

Atualiza o objeto de autoridade do cliente. A descoberta do endpoint deve ser concluída.

Detalhes do Construtor

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Parâmetros

configuration
@azure/msal-common.ClientConfiguration

Detalhes da Propriedade Herdada

authority

authority: Authority

Valor de Propriedade

@azure/msal-common.Authority

Herdado de BaseClient.authority

logger

logger: Logger

Valor de Propriedade

Herdado de BaseClient.logger

Detalhes de Método

acquireToken(CommonDeviceCodeRequest)

Obtém o código do dispositivo a partir do endpoint do código do dispositivo, liga de volta com a resposta do código do dispositivo e questiona o endpoint do token para trocar código do dispositivo por tokens

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

Parâmetros

request
CommonDeviceCodeRequest

o programador forneceu CommonDeviceCodeRequest

Devoluções

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Cria uma cadeia de consulta para o pedido de código do dispositivo

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Parâmetros

request
CommonDeviceCodeRequest

o programador forneceu CommonDeviceCodeRequest

Devoluções

string

Detalhes do Método Herdado

createTokenQueryParameters(BaseAuthRequest)

Cria uma cadeia de consulta para o pedido /token

function createTokenQueryParameters(request: BaseAuthRequest): string

Parâmetros

request
BaseAuthRequest

Devoluções

string

Herdado de BaseClient.createTokenQueryParameters

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

Envolve o sendPostRequestAsync com a lógica necessária de pré-voo e pós-voo

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

Parâmetros

thumbprint
RequestThumbprint

Solicitar impressão digital para limitação

tokenEndpoint

string

Endpoint para fazer o POST para

options
NetworkRequestOptions

Corpo e Cabeçalhos para incluir no pedido POST

correlationId

string

CorrelationId para telemetria

Devoluções

Promise<NetworkResponse<T>>

Herdado de BaseClient.sendPostRequest

updateAuthority(string, string)

Atualiza o objeto de autoridade do cliente. A descoberta do endpoint deve ser concluída.

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

Parâmetros

cloudInstanceHostname

string

correlationId

string

Devoluções

Promise<void>

Herdado de BaseClient.updateAuthority