OpenIdConnectOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Authentication.OpenIdConnect

アセンブリ:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

パッケージ:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

の構成オプションOpenIdConnectHandler

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions

Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions

継承

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

コンストラクター

OpenIdConnectOptions()

新しい OpenIdConnectOptions を初期化します

プロパティ

AccessDeniedPath	ユーザーがリモート サーバーによって要求された承認要求を承認しない場合に、ユーザー エージェントがリダイレクトされる省略可能なパスを取得または設定します。 このプロパティは既定では設定されていません。 この場合、リモート承認サーバーからaccess_denied応答が返された場合、例外がスローされます。 (継承元 RemoteAuthenticationOptions)
AuthenticationMethod	ユーザー エージェントを ID プロバイダーにリダイレクトするために使用するメソッドを取得または設定します。
Authority	OpenIdConnect を呼び出す際に使用する Authority を取得または設定します。
AutomaticRefreshInterval	メタデータの自動更新を実行する頻度を取得または設定します。
Backchannel	リモート ID プロバイダーとの通信に使用されます。 (継承元 RemoteAuthenticationOptions)
BackchannelHttpHandler	リモート ID プロバイダーとの通信に使用される HttpMessageHandler。 値を WebRequestHandler にダウンキャストできない場合、これを BackchannelCertificateValidator と同時に設定することはできません。 (継承元 RemoteAuthenticationOptions)
BackchannelTimeout	リモート ID プロバイダーとのバック チャネル通信のタイムアウト値をミリ秒単位で取得または設定します。 (継承元 RemoteAuthenticationOptions)
CallbackPath	ユーザー エージェントが返される、アプリケーションの基本パス内の要求パス。 この要求が到着するとミドルウェアが処理します。 (継承元 RemoteAuthenticationOptions)
ClaimActions	json ユーザー データから値を選択し、要求を作成するために使用される要求アクションのコレクション。
ClaimsIssuer	作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationSchemeOptions)
ClientId	'client_id' を取得または設定します。
ClientSecret	'client_secret' を取得または設定します。
Configuration	開発者によって直接指定された構成。 指定された場合、MetadataAddress プロパティと Backchannel プロパティは使用されません。 要求の処理中は、この情報を更新しないでください。
ConfigurationManager	メタデータからの構成の取得、キャッシュ、更新を行います。 指定されなかった場合、MetadataAddress プロパティと Backchannel プロパティを使用して作成されます。
CorrelationCookie	Cookie が応答に追加される前に、関連付け Cookie の作成に使用される設定を決定します。 (継承元 RemoteAuthenticationOptions)
DataProtectionProvider	データのセキュリティ保護に使用される型を取得または設定します。 (継承元 RemoteAuthenticationOptions)
DisableTelemetry	テレメトリを無効にするかどうかを示します。 この機能を有効にすると、Microsoft IdentityModel パッケージのアセンブリ バージョンが承認/ログアウト要求パラメーターとしてリモート OpenID Connect プロバイダーに送信されます。
Events	OpenIdConnect メッセージの処理中に通知する を OpenIdConnectEvents 取得または設定します。
EventsType	が設定されている場合は、 プロパティの代わりに Events インスタンスを取得するためのサービスの種類として が使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardAuthenticate	設定されている場合、このスキームで AuthenticateAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardChallenge	設定されている場合、このスキームで ChallengeAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardDefault	設定されている場合、認証ハンドラーが既定ですべての認証操作を に転送する既定のスキームを指定します。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初にチェックされ、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardDefaultSelector	認証ハンドラーが既定ですべての認証操作をに転送する必要がある現在の要求の既定のスキームを選択するために使用されます。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初にチェックされ、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardForbid	設定されている場合、このスキームで ForbidAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardSignIn	設定されている場合、このスキームで SignInAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardSignOut	設定されている場合、このスキームで SignOutAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	トークン エンドポイントから受信した ID を作成した後、ハンドラーがユーザー情報エンドポイントに移動して追加の要求を取得するかどうかを設定id_tokenブール値。 既定値は 'false' です。
MapInboundClaims	SecurityTokenValidator 内の の既定のJwtSecurityTokenHandlerインスタンスの プロパティと TokenHandler の既定のJsonWebTokenHandlerインスタンスの プロパティを取得または設定MapInboundClaimsします。これは、 を検証JwtSecurityTokenするときに抽出される要求の種類をマップするかどうかを判断するときに使用されます。 これが true に設定されている場合、このマッピングを使用して変換した後、要求の種類は JSON 要求 'name' に設定されます。 それ以外の場合、マッピングは行われません。 既定値は、true です。
MaxAge	'max_age' を取得または設定します。 設定した場合、'max_age' パラメーターが認証要求と共に送信されます。 指定した時間内に ID プロバイダーがユーザーをアクティブに認証していない場合、ユーザーは再認証を求められます。 既定では、max_ageは指定されません。
MetadataAddress	メタデータを取得するための検出エンドポイントを取得または設定します。
NonceCookie	Cookie が応答に追加される前に nonce Cookie の作成に使用される設定を決定します。
Prompt	'prompt' を取得または設定します。
ProtocolValidator	受信した OpenIdConnectProtocolValidator 'id_token' が次の値に従って有効であることを確認するために使用される を取得または設定します。 http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	取得に失敗した場合、または更新が明示的に要求された場合に、取得までの最小時間を取得または設定します。
RefreshOnIssuerKeyNotFound	SecurityTokenSignatureKeyNotFoundException の後、メタデータの更新を試行する必要があるかどうかを示す値を取得または設定します。 これにより、署名キー ロールオーバー発生時の自動復旧が可能となります。 この機能は、既定では有効になっています。
RemoteAuthenticationTimeout	認証フローを完了するための時間制限を取得または設定します (既定では 15 分)。 (継承元 RemoteAuthenticationOptions)
RemoteSignOutPath	このパスで受信した要求により、ハンドラーは SignOutScheme を使用して SignOut を呼び出します。
RequireHttpsMetadata	メタデータ アドレスまたは機関に HTTPS が必要かどうかを取得または設定します。 既定値は true です。 これは開発環境でのみ無効にする必要があります。
Resource	'resource' を取得または設定します。
ResponseMode	'response_mode' を取得または設定します。
ResponseType	'response_type' を取得または設定します。
ReturnUrlParameter	アクセスが拒否されたページまでリモート チャレンジがトリガーされる前に、ユーザーの元の場所を伝えるために使用されるパラメーターの名前を取得または設定します。 このプロパティは、 が明示的に指定されている場合 AccessDeniedPath にのみ使用されます。 (継承元 RemoteAuthenticationOptions)
SaveTokens	承認が成功した後、アクセス トークンと更新トークンを AuthenticationProperties に格納するかどうかを定義します。 このプロパティは、最終的な認証 Cookie のサイズを小さくするために、既定で に false 設定されています。 (継承元 RemoteAuthenticationOptions)
Scope	要求するアクセス許可の一覧を取得します。
SecurityTokenValidator	古い. ID トークンの ISecurityTokenValidator 検証に使用される を取得または設定します。
SignedOutCallbackPath	ID プロバイダーからサインアウトした後にユーザー エージェントが返されるアプリケーションのベース パス内の要求パス。 からのpost_logout_redirect_uriを http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout参照してください。
SignedOutRedirectUri	アプリケーションが ID プロバイダーからサインアウトされた後にユーザー エージェントがリダイレクトされる URI。 リダイレクトは、SignedOutCallbackPath が呼び出された後に発生します。
SignInScheme	認証が成功した後にユーザーの ID を保持するミドルウェアに対応する認証スキームを取得または設定します。 この値は、通常、Startup クラスに登録されている Cookie ミドルウェアに対応します。 省略すると、 DefaultSignInScheme がフォールバック値として使用されます。 (継承元 RemoteAuthenticationOptions)
SignOutScheme	SignOutPath の SignOut で使用する認証スキーム。 これが設定されていない場合は、SignInScheme が使用されます。
SkipUnrecognizedRequests	CallbackPath への要求が他のコンポーネントに対して行われる可能性があるかどうかを示します。 有効にした場合、ハンドラーは OpenIdConnect 認証応答を含まない要求を渡します。 これを無効にし、CallbackPath を専用エンドポイントに設定すると、エラー処理が向上する可能性があります。 この機能は、既定では無効になっています。
StateDataFormat	ハンドラーによって処理されるデータをセキュリティで保護するために使用される型を取得または設定します。
StringDataFormat	ハンドラーで使用される文字列をセキュリティで保護するために使用される型を取得または設定します。
TimeProvider	テストに使用されます。 (継承元 AuthenticationSchemeOptions)
TokenHandler	ID トークンの TokenHandler 検証に使用される を取得または設定します。 これは、 が の場合UseSecurityTokenValidatorfalseではなく SecurityTokenValidator 使用されます。
TokenValidationParameters	ID トークンの検証に使用されるパラメーターを取得または設定します。
UsePkce	Proof Key for Code Exchange (PKCE) 標準の使用を有効または無効にします。 これは、 が にCode設定されている場合ResponseTypeにのみ適用されます。 以下を参照してください。https://tools.ietf.org/html/rfc7636 既定値は true です。
UseSecurityTokenValidator	ID トークンの検証に または をTokenHandlerSecurityTokenValidator使用するかどうかを取得または設定します。
UseTokenLifetime	認証セッションの有効期間 (Cookie など) が認証トークンの有効期間と一致する必要があることを示します。 有効期間情報がトークンから得られない場合は、一般的なセッションの有効期間が使用されます。 この機能は、既定では無効になっています。

メソッド

Validate()	オプションが有効であることを確認します。 問題がなければ例外をスローする必要があります。
Validate(String)	オプションが特定のスキームに対して有効であることを確認します (継承元 RemoteAuthenticationOptions)