DeviceCodeClient class

Klient kódu zařízení OAuth2.0

Extends
@azure/msal-common.BaseClient

Zděděné vlastnosti

authority
logger

Metody

acquireToken(CommonDeviceCodeRequest)

Získá kód zařízení z koncového bodu kódu zařízení, volání zpět s odpovědí na kód zařízení a dotazuje koncový bod tokenu pro výměnu kódu zařízení pro tokeny.

createExtraQueryParameters(CommonDeviceCodeRequest)

Vytvoří řetězec dotazu pro požadavek na kód zařízení.

Zděděné metody

createTokenQueryParameters(BaseAuthRequest)

Vytvoří řetězec dotazu pro požadavek /token.

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

Zalamuje sendPostRequestAsync s nezbytnou předběžnou a pozletovou logikou.

updateAuthority(string, string)

Aktualizuje objekt autority klienta. Zjišťování koncových bodů musí být dokončeno.

Podrobnosti konstruktoru

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Parametry

configuration
@azure/msal-common.ClientConfiguration

Podrobnosti zděděných vlastností

authority

authority: Authority

Hodnota vlastnosti

@azure/msal-common.Authority

Zděděno z BaseClient.authority

logger

logger: Logger

Hodnota vlastnosti

Zděděno z BaseClient.logger

Podrobnosti metody

acquireToken(CommonDeviceCodeRequest)

Získá kód zařízení z koncového bodu kódu zařízení, volání zpět s odpovědí na kód zařízení a dotazuje koncový bod tokenu pro výměnu kódu zařízení pro tokeny.

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

Parametry

request
CommonDeviceCodeRequest

Developer provided CommonDeviceCodeRequest

Návraty

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Vytvoří řetězec dotazu pro požadavek na kód zařízení.

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Parametry

request
CommonDeviceCodeRequest

Developer provided CommonDeviceCodeRequest

Návraty

string

Podrobnosti zděděných metod

createTokenQueryParameters(BaseAuthRequest)

Vytvoří řetězec dotazu pro požadavek /token.

function createTokenQueryParameters(request: BaseAuthRequest): string

Parametry

request
BaseAuthRequest

Návraty

string

Zděděno z BaseClient.createTokenQueryParameters

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

Zalamuje sendPostRequestAsync s nezbytnou předběžnou a pozletovou logikou.

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

Parametry

thumbprint
RequestThumbprint

Vyžádání kryptografického otisku pro omezování

tokenEndpoint

string

Koncový bod pro vytvoření post na

options
NetworkRequestOptions

Text a hlavičky, které se mají zahrnout do požadavku POST

correlationId

string

Id korelace pro telemetrii

Návraty

Promise<NetworkResponse<T>>

Zděděno z BaseClient.sendPostRequest

updateAuthority(string, string)

Aktualizuje objekt autority klienta. Zjišťování koncových bodů musí být dokončeno.

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

Parametry

cloudInstanceHostname

string

correlationId

string

Návraty

Promise<void>

Zděděno z BaseClient.updateAuthority