AuthenticationResult Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Zawiera wyniki jednej operacji pozyskiwania tokenu w pliku PublicClientApplication lub ConfidentialClientApplication. Aby uzyskać szczegółowe informacje, zobacz https://aka.ms/msal-net-authenticationresult
public class AuthenticationResult
type AuthenticationResult = class
Public Class AuthenticationResult
- Dziedziczenie
-
AuthenticationResult
Konstruktory
| Nazwisko | Opis |
|---|---|
| AuthenticationResult(String, Boolean, String, DateTimeOffset, DateTimeOffset, String, IAccount, String, IEnumerable<String>, Guid, AuthenticationResultMetadata, String) |
Konstruktor przeznaczony do ułatwienia deweloperom aplikacji testowania swoich aplikacji. Umożliwia wyśmiewanie przepływów uwierzytelniania. Deweloperzy aplikacji nigdy nie powinni być nowi AuthenticationResult w kodzie produktu. |
| AuthenticationResult(String, Boolean, String, DateTimeOffset, DateTimeOffset, String, IAccount, String, IEnumerable<String>, Guid, String, AuthenticationResultMetadata, ClaimsPrincipal, String, IReadOnlyDictionary<String,String>) |
Konstruktor przeznaczony do ułatwienia deweloperom aplikacji testowania swoich aplikacji. Umożliwia wyśmiewanie przepływów uwierzytelniania. Deweloperzy aplikacji nigdy nie powinni być nowi AuthenticationResult w kodzie produktu. |
Właściwości
| Nazwisko | Opis |
|---|---|
| AccessToken |
Token dostępu, który może służyć jako token elementu nośnego do uzyskiwania dostępu do chronionych internetowych interfejsów API |
| Account |
Pobiera informacje o koncie. Niektóre elementy w pliku IAccount mogą mieć wartość null, jeśli nie zostaną zwrócone przez usługę. Konto można przekazać z powrotem w niektórych przeciążeniach interfejsu API, aby określić, które konto powinno być używane, takie jak AcquireTokenSilent(IEnumerable<String>, IAccount) lub RemoveAsync(IAccount) na przykład |
| AdditionalResponseParameters |
Uwidacznia dodatkowe parametry odpowiedzi zwracane przez wystawcę tokenu (AAD). |
| AuthenticationResultMetadata |
Zawiera metadane dla wyniku uwierzytelniania. |
| BindingCertificate |
Certyfikat X509 powiązany z tokenem dostępu, gdy użyto biblioteki mTLS-PoP. |
| ClaimsPrincipal |
Wszystkie oświadczenia obecne w tokenie identyfikatora. |
| CorrelationId |
Pobiera identyfikator korelacji używany dla żądania. |
| ExpiresOn |
Pobiera punkt w czasie, w którym token dostępu zwrócony we AccessToken właściwości przestaje być prawidłowy. Ta wartość jest obliczana na podstawie bieżącego czasu UTC mierzonego lokalnie, a wartość wygasaW odebraniu z usługi. |
| ExtendedExpiresOn |
Przestarzałe.
Pobiera punkt w czasie, w którym token dostępu zwrócony we właściwości AccessToken przestaje być prawidłowy w rozszerzonym czasie życia biblioteki MSAL. Ta wartość jest obliczana na podstawie bieżącego czasu UTC mierzonego lokalnie i wartości ext_expiresIn odebranej z usługi. |
| IdToken |
Pobiera token identyfikatora, jeśli jest zwracany przez usługę lub ma wartość null, jeśli nie zostanie zwrócony żaden token identyfikatora. |
| IsExtendedLifeTimeToken |
Przestarzałe.
W przypadku, gdy Azure usługa AD ma awarię, aby była bardziej odporna, może zwracać tokeny z upływem czasu wygaśnięcia, a także z dłuższym czasem wygaśnięcia. Tokeny są następnie automatycznie odświeżane przez bibliotekę MSAL, gdy czas jest dłuższy niż czas wygaśnięcia, z wyjątkiem sytuacji, gdy wartość ExtendedLifeTimeEnabled ma wartość true, a czas jest krótszy niż dłuższy czas wygaśnięcia. Dzieje się tak w połączeniu z oprogramowaniem pośredniczącym interfejsów API sieci Web, które po włączeniu tego rozszerzonego czasu życia może akceptować nieco wygasłe tokeny. Aplikacje klienckie akceptują tokeny czasu wygaśnięcia rozszerzonego tylko wtedy, gdy wartość logiczna ExtendedLifeTimeEnabled jest ustawiona na wartość true w bazie clientApplicationBase. |
| Scopes |
Pobiera przyznane wartości zakresu zwracane przez usługę. |
| SpaAuthCode |
Pobiera kod autoryzacji SPA, jeśli zażądano metody WithSpaAuthorizationCode w konstruktorze AcquireTokenByAuthorizationCode. Zobacz https://aka.ms/msal-net/spa-auth-code , aby uzyskać szczegółowe informacje. |
| TenantId |
Pobiera identyfikator dzierżawy usługi Azure AD, z której został uzyskany token. Ta właściwość będzie mieć wartość null, jeśli informacje o dzierżawie nie zostaną zwrócone przez usługę. |
| TokenType |
Określa typ tokenu dostępu. Domyślnie tokeny zwracane przez Azure Active Directory to tokeny elementu nośnego. |
| UniqueId |
Pobiera unikatowy identyfikator konta w tym TenantId ustawieniu jako oświadczenie identyfikatora oid (ObjectId) lub jeśli to oświadczenie to |
Metody
| Nazwisko | Opis |
|---|---|
| CreateAuthorizationHeader() |
Tworzy zawartość nagłówka autoryzacji HTTP z tego wyniku uwierzytelniania, aby można było wywołać chroniony interfejs API |
Metody rozszerzania
| Nazwisko | Opis |
|---|---|
| GetRefreshToken(AuthenticationResult) |
Zwraca token odświeżania z wyniku uwierzytelniania, jeśli jest dostępny. Jest to przeznaczone dla zaawansowanych scenariuszy, w których obiekt wywołujący zarządza własną pamięcią podręczną tokenów, na przykład w przypadku korzystania z programu DisableInternalCacheOptions. |