DeviceCodeClient class
OAuth2.0-Gerätecodeclient
- Extends
-
@azure/msal-common.BaseClient
Konstruktoren
| Device |
Methoden
| acquire |
Ruft Gerätecode vom Gerätecodeendpunkt ab, ruft mit der Gerätecodeantwort zurück und ruft tokenendpunkt ab, um Gerätecode für Token auszutauschen. |
| create |
Erstellt abfragezeichenfolge für die Gerätecodeanforderung |
Geerbte Methoden
| create |
Erstellt abfragezeichenfolge für die /token-Anforderung |
| send |
Wraps sendPostRequestAsync with necessary preflight and postflight logic |
| update |
Aktualisiert das Autoritätsobjekt des Clients. Die Endpunktermittlung muss abgeschlossen sein. |
Details zum Konstruktor
DeviceCodeClient(ClientConfiguration)
new DeviceCodeClient(configuration: ClientConfiguration)
Parameter
- configuration
- @azure/msal-common.ClientConfiguration
Geerbte Eigenschaftsdetails
authority
authority: Authority
Eigenschaftswert
Geerbt von BaseClient.authority
logger
Details zur Methode
acquireToken(CommonDeviceCodeRequest)
Ruft Gerätecode vom Gerätecodeendpunkt ab, ruft mit der Gerätecodeantwort zurück und ruft tokenendpunkt ab, um Gerätecode für Token auszutauschen.
function acquireToken(request: CommonDeviceCodeRequest): Promise<null | AuthenticationResult>
Parameter
- request
- CommonDeviceCodeRequest
Entwickler bereitgestellt CommonDeviceCodeRequest
Gibt zurück
Promise<null | AuthenticationResult>
createExtraQueryParameters(CommonDeviceCodeRequest)
Erstellt abfragezeichenfolge für die Gerätecodeanforderung
function createExtraQueryParameters(request: CommonDeviceCodeRequest): string
Parameter
- request
- CommonDeviceCodeRequest
Entwickler bereitgestellt CommonDeviceCodeRequest
Gibt zurück
string
Details zur geerbten Methode
createTokenQueryParameters(BaseAuthRequest)
Erstellt abfragezeichenfolge für die /token-Anforderung
function createTokenQueryParameters(request: BaseAuthRequest): string
Parameter
- request
- BaseAuthRequest
Gibt zurück
string
Geerbt von BaseClient.createTokenQueryParameters
sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)
Wraps sendPostRequestAsync with necessary preflight and postflight logic
function sendPostRequest<T>(thumbprint: RequestThumbprint, tokenEndpoint: string, options: NetworkRequestOptions, correlationId: string): Promise<NetworkResponse<T>>
Parameter
- thumbprint
- RequestThumbprint
Anfordern des Fingerabdrucks für die Drosselung
- tokenEndpoint
-
string
Endpunkt, um post in
- options
- NetworkRequestOptions
Textkörper und Kopfzeilen, die in die POST-Anforderung aufgenommen werden sollen
- correlationId
-
string
CorrelationId für Telemetrie
Gibt zurück
Promise<NetworkResponse<T>>
Geerbt von BaseClient.sendPostRequest
updateAuthority(string, string)
Aktualisiert das Autoritätsobjekt des Clients. Die Endpunktermittlung muss abgeschlossen sein.
function updateAuthority(cloudInstanceHostname: string, correlationId: string): Promise<void>
Parameter
- cloudInstanceHostname
-
string
- correlationId
-
string
Gibt zurück
Promise<void>
Geerbt von BaseClient.updateAuthority