DeviceCodeClient class
Client del codice del dispositivo OAuth2.0
- Extends
-
@azure/msal-common.BaseClient
Costruttori
| Device |
Metodi
| acquire |
Ottiene il codice del dispositivo dall'endpoint del codice del dispositivo, le chiamate a con la risposta del codice del dispositivo e esegue il polling dell'endpoint del token per scambiare il codice del dispositivo per i token |
| create |
Crea una stringa di query per la richiesta di codice del dispositivo |
Metodi ereditati
| create |
Crea una stringa di query per la richiesta /token |
| send |
Esegue il wrapping di sendPostRequestAsync con la logica preliminare e postflight necessaria |
| update |
Aggiorna l'oggetto autorità del client. L'individuazione degli endpoint deve essere completata. |
Dettagli costruttore
DeviceCodeClient(ClientConfiguration)
new DeviceCodeClient(configuration: ClientConfiguration)
Parametri
- configuration
- @azure/msal-common.ClientConfiguration
Dettagli proprietà ereditate
authority
authority: Authority
Valore della proprietà
Ereditato da BaseClient.authority
logger
Dettagli metodo
acquireToken(CommonDeviceCodeRequest)
Ottiene il codice del dispositivo dall'endpoint del codice del dispositivo, le chiamate a con la risposta del codice del dispositivo e esegue il polling dell'endpoint del token per scambiare il codice del dispositivo per i token
function acquireToken(request: CommonDeviceCodeRequest): Promise<null | AuthenticationResult>
Parametri
- request
- CommonDeviceCodeRequest
CommonDeviceCodeRequest fornito dallo sviluppatore
Valori restituiti
Promise<null | AuthenticationResult>
createExtraQueryParameters(CommonDeviceCodeRequest)
Crea una stringa di query per la richiesta di codice del dispositivo
function createExtraQueryParameters(request: CommonDeviceCodeRequest): string
Parametri
- request
- CommonDeviceCodeRequest
CommonDeviceCodeRequest fornito dallo sviluppatore
Valori restituiti
string
Dettagli dei metodi ereditati
createTokenQueryParameters(BaseAuthRequest)
Crea una stringa di query per la richiesta /token
function createTokenQueryParameters(request: BaseAuthRequest): string
Parametri
- request
- BaseAuthRequest
Valori restituiti
string
Ereditato da BaseClient.createTokenQueryParameters
sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)
Esegue il wrapping di sendPostRequestAsync con la logica preliminare e postflight necessaria
function sendPostRequest<T>(thumbprint: RequestThumbprint, tokenEndpoint: string, options: NetworkRequestOptions, correlationId: string): Promise<NetworkResponse<T>>
Parametri
- thumbprint
- RequestThumbprint
Richiedere l'identificazione personale per la limitazione
- tokenEndpoint
-
string
Endpoint per impostare post su
- options
- NetworkRequestOptions
Corpo e intestazioni da includere nella richiesta POST
- correlationId
-
string
CorrelationId per i dati di telemetria
Valori restituiti
Promise<NetworkResponse<T>>
Ereditato da BaseClient.sendPostRequest
updateAuthority(string, string)
Aggiorna l'oggetto autorità del client. L'individuazione degli endpoint deve essere completata.
function updateAuthority(cloudInstanceHostname: string, correlationId: string): Promise<void>
Parametri
- cloudInstanceHostname
-
string
- correlationId
-
string
Valori restituiti
Promise<void>
Ereditato da BaseClient.updateAuthority