DeviceCodeClient class

Cliente de código do dispositivo OAuth2.0

Extends
@azure/msal-common.BaseClient

Propriedades herdadas

authority
logger

Métodos

acquireToken(CommonDeviceCodeRequest)

Obtém o código do dispositivo do ponto de extremidade de código do dispositivo, chamadas de volta com resposta de código do dispositivo e sonda o ponto de extremidade do token para trocar o código do dispositivo por tokens

createExtraQueryParameters(CommonDeviceCodeRequest)

Cria uma cadeia de caracteres de consulta para a solicitação de código do dispositivo

Métodos herdados

createTokenQueryParameters(BaseAuthRequest)

Cria uma cadeia de caracteres de consulta para a solicitação /token

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

Encapsula sendPostRequestAsync com a lógica necessária de pré-vôo e postflight

updateAuthority(string, string)

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

Detalhes do construtor

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Parâmetros

configuration
@azure/msal-common.ClientConfiguration

Detalhes das propriedades herdadas

authority

authority: Authority

Valor da propriedade

@azure/msal-common.Authority

Herdado de BaseClient.authority

logger

logger: Logger

Valor da propriedade

Herdado de BaseClient.logger

Detalhes do método

acquireToken(CommonDeviceCodeRequest)

Obtém o código do dispositivo do ponto de extremidade de código do dispositivo, chamadas de volta com resposta de código do dispositivo e sonda o ponto de extremidade do token para trocar o código do dispositivo por tokens

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

Parâmetros

request
CommonDeviceCodeRequest

desenvolvedor fornecido CommonDeviceCodeRequest

Retornos

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Cria uma cadeia de caracteres de consulta para a solicitação de código do dispositivo

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Parâmetros

request
CommonDeviceCodeRequest

desenvolvedor fornecido CommonDeviceCodeRequest

Retornos

string

Detalhes do método herdado

createTokenQueryParameters(BaseAuthRequest)

Cria uma cadeia de caracteres de consulta para a solicitação /token

function createTokenQueryParameters(request: BaseAuthRequest): string

Parâmetros

request
BaseAuthRequest

Retornos

string

Herdado de BaseClient.createTokenQueryParameters

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

Encapsula sendPostRequestAsync com a lógica necessária de pré-vôo e postflight

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

Ponto de extremidade para fazer o POST para

options
NetworkRequestOptions

Corpo e cabeçalhos a serem incluídos na solicitação POST

correlationId

string

CorrelationId para telemetria

Retornos

Promise<NetworkResponse<T>>

Herdado de BaseClient.sendPostRequest

updateAuthority(string, string)

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

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

Parâmetros

cloudInstanceHostname

string

correlationId

string

Retornos

Promise<void>

Herdado de BaseClient.updateAuthority