JwtBearerOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Builder

アセンブリ:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

パッケージ:

Microsoft.AspNetCore.Authentication.JwtBearer v1.1.0

オプション クラスは、ベアラー認証のミドルウェアの動作を制御するために必要な情報を提供します。

public ref class JwtBearerOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions

public class JwtBearerOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions

type JwtBearerOptions = class
    inherit AuthenticationOptions

Public Class JwtBearerOptions
Inherits AuthenticationOptions

継承

Object

AuthenticationOptions

JwtBearerOptions

コンストラクター

JwtBearerOptions()

既定値を使って、ベアラー認証オプションのインスタンスを作成します。

プロパティ

Audience	受信した OpenIdConnect トークンの対象ユーザーを取得または設定します。
AuthenticationScheme	オプションの AuthenticationScheme は、特定の認証スキームの論理名に対応します。 同じ種類の認証ミドルウェアを複数回パイプラインで使用するために、異なる値を割り当てることができます。 (継承元 AuthenticationOptions)
Authority	OpenIdConnect を呼び出す際に使用する Authority を取得または設定します。
AutomaticAuthenticate	true の場合、認証ミドルウェアによって、入ってくる要求ユーザーが変更されます。 false の場合、認証ミドルウェアは AuthenticationScheme によって明示的に示された場合にのみ ID を提供します。 (継承元 AuthenticationOptions)
AutomaticChallenge	true の場合、認証ミドルウェアは自動チャレンジを処理する必要があります。 false の場合、認証ミドルウェアは AuthenticationScheme によって明示的に示された場合にのみ応答を変更します。 (継承元 AuthenticationOptions)
BackchannelHttpHandler	メタデータを取得するための HttpMessageHandler。 値が WebRequestHandler の場合以外、これを BackchannelCertificateValidator と同時に設定することはできません。
BackchannelTimeout	バックチャネルを使用して http 呼び出しを行うときに使用するタイムアウトを取得または設定します。
Challenge	"WWW-Authenticate" ヘッダーに配置するチャレンジを取得または設定します。
ClaimsIssuer	作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationOptions)
Configuration	開発者によって直接指定された構成。 指定された場合、MetadataAddress プロパティと Backchannel プロパティは使用されません。 要求の処理中は、この情報を更新しないでください。
ConfigurationManager	メタデータからの構成の取得、キャッシュ、更新を行います。 指定されなかった場合、MetadataAddress プロパティと Backchannel プロパティを使用して作成されます。
Description	アプリケーションから使用可能な、認証の種類に関する追加情報。 (継承元 AuthenticationOptions)
Events	ベアラー認証のミドルウェアが発生させたイベントを処理するために、アプリケーションが提供するオブジェクト。 アプリケーションはインターフェイスを完全に実装するか、JwtBearerAuthenticationEvents のインスタンスを作成し、処理するイベントにのみデリゲートを割り当てることができます。
IncludeErrorDetails	トークン検証エラーを呼び出し元に返す必要があるかどうかを定義します。 既定では、このオプションを無効にして、JWT ミドルウェアがエラーと WWW-Authenticate ヘッダーのerror_descriptionを返さないようにすることができます。
MetadataAddress	メタデータを取得するための検出エンドポイントを取得または設定します。
RefreshOnIssuerKeyNotFound	SecurityTokenSignatureKeyNotFoundException の後、メタデータの更新を試行する必要があるかどうかを示す値を取得または設定します。 これにより、署名キー ロールオーバー発生時の自動復旧が可能となります。 この機能は、既定では有効になっています。
RequireHttpsMetadata	メタデータ アドレスまたは機関に HTTPS が必要かどうかを取得または設定します。 既定値は true です。 これは開発環境でのみ無効にする必要があります。
SaveToken	承認が成功した後にベアラー トークンを AuthenticationProperties に格納するかどうかを定義します。
SecurityTokenValidators	アクセス トークンの検証に使用される の ISecurityTokenValidator 順序付きリストを取得します。
SystemClock	For testing purposes only. (継承元 AuthenticationOptions)
TokenValidationParameters	ID トークンの検証に使用されるパラメーターを取得または設定します。