DeviceCodeClient class

Client de code d’appareil OAuth2.0

Extends
@azure/msal-common.BaseClient

Propriétés héritées

authority
logger

Méthodes

acquireToken(CommonDeviceCodeRequest)

Obtient le code de l’appareil à partir du point de terminaison du code d’appareil, renvoie les appels à la réponse du code de l’appareil et interroge le point de terminaison de jeton pour échanger du code d’appareil pour les jetons

createExtraQueryParameters(CommonDeviceCodeRequest)

Crée une chaîne de requête pour la demande de code d’appareil

Méthodes héritées

createTokenQueryParameters(BaseAuthRequest)

Crée une chaîne de requête pour la requête /token

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

Wraps sendPostRequestAsync avec la logique préliminaire et post-vol nécessaire

updateAuthority(string, string)

Met à jour l’objet d’autorité du client. La découverte du point de terminaison doit être terminée.

Détails du constructeur

DeviceCodeClient(ClientConfiguration)

new DeviceCodeClient(configuration: ClientConfiguration)

Paramètres

configuration
@azure/msal-common.ClientConfiguration

Détails de la propriété héritée

authority

authority: Authority

Valeur de propriété

@azure/msal-common.Authority

Hérité de BaseClient.authority

logger

logger: Logger

Valeur de propriété

Hérité de BaseClient.logger

Détails de la méthode

acquireToken(CommonDeviceCodeRequest)

Obtient le code de l’appareil à partir du point de terminaison du code d’appareil, renvoie les appels à la réponse du code de l’appareil et interroge le point de terminaison de jeton pour échanger du code d’appareil pour les jetons

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

Paramètres

request
CommonDeviceCodeRequest

développeur fourni CommonDeviceCodeRequest

Retours

Promise<null | AuthenticationResult>

createExtraQueryParameters(CommonDeviceCodeRequest)

Crée une chaîne de requête pour la demande de code d’appareil

function createExtraQueryParameters(request: CommonDeviceCodeRequest): string

Paramètres

request
CommonDeviceCodeRequest

développeur fourni CommonDeviceCodeRequest

Retours

string

Détails de la méthode héritée

createTokenQueryParameters(BaseAuthRequest)

Crée une chaîne de requête pour la requête /token

function createTokenQueryParameters(request: BaseAuthRequest): string

Paramètres

request
BaseAuthRequest

Retours

string

Hérité de BaseClient.createTokenQueryParameters

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

Wraps sendPostRequestAsync avec la logique préliminaire et post-vol nécessaire

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

Paramètres

thumbprint
RequestThumbprint

Empreinte numérique de la demande pour la limitation

tokenEndpoint

string

Point de terminaison pour rendre POST à

options
NetworkRequestOptions

Corps et en-têtes à inclure sur la requête POST

correlationId

string

CorrelationId pour la télémétrie

Retours

Promise<NetworkResponse<T>>

Hérité de BaseClient.sendPostRequest

updateAuthority(string, string)

Met à jour l’objet d’autorité du client. La découverte du point de terminaison doit être terminée.

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

Paramètres

cloudInstanceHostname

string

correlationId

string

Retours

Promise<void>

Hérité de BaseClient.updateAuthority