OpenIdConnectOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Authentication.OpenIdConnect

アセンブリ:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

パッケージ:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

ソース:

OpenIdConnectOptions.cs

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 呼び出しを行うときに使用する機関を取得または設定します。
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 の既定のインスタンスの MapInboundClaims プロパティと TokenHandler の JsonWebTokenHandler の既定のインスタンスを取得または設定します。これは、JwtSecurityTokenの検証時に抽出される要求の種類をマップするかどうかを決定するときに使用されます。 これが true に設定されている場合、要求の種類は、このマッピングを使用して変換した後、JSON 要求 'name' に設定されます。 それ以外の場合、マッピングは行われません。 既定値は true です。
MaxAge	'max_age' を取得または設定します。 設定すると、認証要求と共に 'max_age' パラメーターが送信されます。 指定された時間内に ID プロバイダーがユーザーをアクティブに認証していない場合、ユーザーは再認証を求められます。 既定では、max_ageは指定されません。
MetadataAddress	メタデータを取得するための検出エンドポイントを取得または設定します。
NonceCookie	応答に Cookie が追加される前に nonce Cookie の作成に使用される設定を決定します。
Prompt	'prompt' を取得または設定します。
ProtocolValidator	受信した 'id_token' が次の値に従って有効であることを確認するために使用される OpenIdConnectProtocolValidator を取得または設定します 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 に格納するかどうかを定義します。 このプロパティは既定で false に設定され、最終的な認証 Cookie のサイズが小さくなります。 (継承元 RemoteAuthenticationOptions)
Scope	要求するアクセス許可の一覧を取得します。
SecurityTokenValidator	古い. ID トークンの検証に使用する ISecurityTokenValidator を取得または設定します。
SignedOutCallbackPath	ID プロバイダーからサインアウトした後にユーザー エージェントが返される、アプリケーションのベース パス内の要求パス。 http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogoutからpost_logout_redirect_uriを参照してください。
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 を取得または設定します。 これは、UseSecurityTokenValidator が false場合に SecurityTokenValidator の代わりに使用されます。
TokenValidationParameters	ID トークンの検証に使用するパラメーターを取得または設定します。
UsePkce	Proof Key for Code Exchange (PKCE) 標準の使用を有効または無効にします。 これは、ResponseType が Codeに設定されている場合にのみ適用されます。 https://tools.ietf.org/html/rfc7636を参照してください。 既定値は trueです。
UseSecurityTokenValidator	ID トークンの検証に TokenHandler または SecurityTokenValidator のどちらを使用するかを取得または設定します。
UseTokenLifetime	認証セッションの有効期間 (Cookie など) が認証トークンの有効期間と一致する必要があることを示します。 トークンが有効期間情報を提供しない場合は、通常のセッションの有効期間が使用されます。 これは既定では無効になっています。

メソッド

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