AuthenticationResult クラス

定義

名前空間:
Microsoft.Identity.Client
アセンブリ:
Microsoft.Identity.Client.dll
パッケージ:
Microsoft.Identity.Client v4.84.2

PublicClientApplicationまたは ConfidentialClientApplication での 1 つのトークン取得操作の結果を格納します。 詳細については、以下を参照してください。 https://aka.ms/msal-net-authenticationresult

public class AuthenticationResult
type AuthenticationResult = class
Public Class AuthenticationResult
継承
Object
AuthenticationResult

コンストラクター

名前 説明
AuthenticationResult(String, Boolean, String, DateTimeOffset, DateTimeOffset, String, IAccount, String, IEnumerable<String>, Guid, AuthenticationResultMetadata, String)

アプリケーション開発者がアプリをテストするのに役立つコンストラクター。 認証フローのモック作成を許可します。 アプリ開発者は、製品コードでAuthenticationResultを新規に作成しないでください。
AuthenticationResult(String, Boolean, String, DateTimeOffset, DateTimeOffset, String, IAccount, String, IEnumerable<String>, Guid, String, AuthenticationResultMetadata, ClaimsPrincipal, String, IReadOnlyDictionary<String,String>)

アプリケーション開発者がアプリをテストするのに役立つコンストラクター。 認証フローのモック作成を許可します。 アプリ開発者は、製品コードでAuthenticationResultを新規に作成しないでください。

プロパティ

名前 説明
AccessToken

保護された Web API にアクセスするためのベアラー トークンとして使用できるアクセス トークン
Account

アカウント情報を取得します。 IAccount内の一部の要素は、サービスによって返されない場合は null になる可能性があります。 アカウントを一部の API オーバーロードに戻して、 AcquireTokenSilent(IEnumerable<String>, IAccount) や RemoveAsync(IAccount) など、使用する必要があるアカウントを特定できます
AdditionalResponseParameters

トークン発行者 (AAD) によって返される追加の応答パラメーターを公開します。
AuthenticationResultMetadata

認証結果のメタデータが含まれています。
BindingCertificate

mTLS-PoP が使用されたときにアクセス トークンにバインドされた X509 証明書。
ClaimsPrincipal

ID トークンに存在するすべての要求。
CorrelationId

要求に使用される関連付け ID を取得します。
ExpiresOn

AccessToken プロパティで返されたアクセス トークンが有効でなくなる時点を取得します。 この値は、ローカルで測定された現在の UTC 時刻に基づいて計算され、サービスから受信した値 expiresIn に基づいて計算されます。
ExtendedExpiresOn
古い.

AccessToken プロパティで返されたアクセス トークンが MSAL の拡張 LifeTime で有効でなくなる時点を取得します。 この値は、ローカルで測定された現在の UTC 時刻と、サービスから受信ext_expiresIn値に基づいて計算されます。
IdToken

サービスによって返された場合は ID トークンを取得し、ID トークンが返されない場合は null を取得します。
IsExtendedLifeTimeToken
古い.

Azure AD で障害が発生した場合、回復性を高めるために、有効期限が切れ、有効期限が延長されたトークンを返すことができます。 ExtendedLifeTimeEnabled が true で、時間が延長有効期限よりも短い場合を除き、時刻が有効期限を超えると、トークンは MSAL によって自動的に更新されます。 これは Web API ミドルウェアと組み合わされ、この延長有効期間が有効になると、わずかに期限切れのトークンを受け入れる可能性があります。 クライアント アプリケーションは、ClientApplicationBase で ExtendedLifeTimeEnabled ブール値が true に設定されている場合にのみ、延長有効期間トークンを受け入れます。
Scopes

サービスによって返される付与されたスコープ値を取得します。
SpaAuthCode

AcquireTokenByAuthorizationCode ビルダーで WithSpaAuthorizationCode メソッドを使用して要求された場合は、SPA 承認コードを取得します。 詳細については、https://aka.ms/msal-net/spa-auth-code を参照してください。
TenantId

トークンの取得元のAzure AD テナントの識別子を取得します。 サービスからテナント情報が返されない場合、このプロパティは null になります。
TokenType

アクセス トークンの種類を識別します。 既定では、Azure Active Directoryによって返されるトークンはベアラー トークンです。
<seealso cref="M:Microsoft.AuthenticationResult から HTTP 承認ヘッダーを取得するための Identity.Client.AuthenticationResult.CreateAuthorizationHeader"></seealso>。
UniqueId

この TenantId 内のアカウントの一意の ID を取得します。oid (ObjectId) 要求として設定されるか、その要求が null場合は、null でないと保証されるサブ (サブジェクト) 要求として設定されます。

メソッド

名前 説明
CreateAuthorizationHeader()

保護された API を呼び出すことができるように、この認証結果から HTTP 承認ヘッダーのコンテンツを作成します

拡張メソッド

名前 説明
GetRefreshToken(AuthenticationResult)

認証結果から更新トークンを返します (使用可能な場合)。 これは、呼び出し元が独自のトークン キャッシュを管理する高度なシナリオ (たとえば、 DisableInternalCacheOptionsを使用する場合) を対象としています。

適用対象