OpenIdConnectOptions クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
の構成オプションOpenIdConnectMiddleware
public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions
public class OpenIdConnectOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions
type OpenIdConnectOptions = class
inherit RemoteAuthenticationOptions
Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions
- 継承
コンストラクター
OpenIdConnectOptions() |
新しい OpenIdConnectOptions を初期化します |
OpenIdConnectOptions(String) |
新しい OpenIdConnectOptions を初期化します |
プロパティ
AuthenticationMethod |
ユーザー エージェントを ID プロバイダーにリダイレクトするために使用するメソッドを取得または設定します。 |
AuthenticationScheme |
オプションの AuthenticationScheme は、特定の認証スキームの論理名に対応します。 同じ種類の認証ミドルウェアを複数回パイプラインで使用するために、異なる値を割り当てることができます。 (継承元 AuthenticationOptions) |
Authority |
OpenIdConnect を呼び出す際に使用する Authority を取得または設定します。 |
AutomaticAuthenticate |
true の場合、認証ミドルウェアによって、入ってくる要求ユーザーが変更されます。 false の場合、認証ミドルウェアは AuthenticationScheme によって明示的に示された場合にのみ ID を提供します。 (継承元 AuthenticationOptions) |
AutomaticChallenge |
true の場合、認証ミドルウェアは自動チャレンジを処理する必要があります。 false の場合、認証ミドルウェアは AuthenticationScheme によって明示的に示された場合にのみ応答を変更します。 (継承元 AuthenticationOptions) |
BackchannelHttpHandler |
リモート ID プロバイダーとの通信に使用される HttpMessageHandler。 値を WebRequestHandler にダウンキャストできない場合、これを BackchannelCertificateValidator と同時に設定することはできません。 (継承元 RemoteAuthenticationOptions) |
BackchannelTimeout |
リモート ID プロバイダーとのバック チャネル通信のタイムアウト値をミリ秒単位で取得または設定します。 (継承元 RemoteAuthenticationOptions) |
CallbackPath |
ユーザー エージェントが返される、アプリケーションの基本パス内の要求パス。 この要求が到着するとミドルウェアが処理します。 (継承元 RemoteAuthenticationOptions) |
ClaimsIssuer |
作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationOptions) |
ClientId |
'client_id' を取得または設定します。 |
ClientSecret |
'client_secret' を取得または設定します。 |
Configuration |
開発者によって直接指定された構成。 指定された場合、MetadataAddress プロパティと Backchannel プロパティは使用されません。 要求の処理中は、この情報を更新しないでください。 |
ConfigurationManager |
メタデータからの構成の取得、キャッシュ、更新を行います。 指定されなかった場合、MetadataAddress プロパティと Backchannel プロパティを使用して作成されます。 |
Description |
アプリケーションから使用可能な、認証の種類に関する追加情報。 (継承元 AuthenticationOptions) |
DisplayName |
ユーザーがサインイン ユーザー インターフェイスに表示できるテキストを取得または設定します。 (継承元 RemoteAuthenticationOptions) |
Events |
OpenIdConnect メッセージの処理中に通知する を IOpenIdConnectEvents 取得または設定します。 |
GetClaimsFromUserInfoEndpoint |
トークン エンドポイントから受信した ID を作成した後、ミドルウェアがユーザー情報エンドポイントに移動して追加の要求を取得するかどうかを設定id_tokenブール値。 既定値は 'false' です。 |
MetadataAddress |
メタデータを取得するための検出エンドポイントを取得または設定します。 |
PostLogoutRedirectUri |
アプリケーションが ID プロバイダーからサインアウトされた後にユーザー エージェントが返される URI。 リダイレクトは、SignedOutCallbackPath が呼び出された後に発生します。 |
ProtocolValidator |
受信した OpenIdConnectProtocolValidator 'id_token' が次の値に従って有効であることを確認するために使用される を取得または設定します。 http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation |
RefreshOnIssuerKeyNotFound |
SecurityTokenSignatureKeyNotFoundException の後、メタデータの更新を試行する必要があるかどうかを示す値を取得または設定します。 これにより、署名キー ロールオーバー発生時の自動復旧が可能となります。 この機能は、既定では有効になっています。 |
RemoteAuthenticationTimeout |
認証フローを完了するための時間制限を取得または設定します (既定では 15 分)。 (継承元 RemoteAuthenticationOptions) |
RemoteSignOutPath |
このパスで受信した要求により、ミドルウェアは SignInScheme を使用して SignOut を呼び出します。 |
RequireHttpsMetadata |
メタデータ アドレスまたは機関に HTTPS が必要かどうかを取得または設定します。 既定値は true です。 これは開発環境でのみ無効にする必要があります。 |
Resource |
'resource' を取得または設定します。 |
ResponseMode |
'response_mode' を取得または設定します。 |
ResponseType |
'response_type' を取得または設定します。 |
SaveTokens |
承認が成功した後、アクセス トークンと更新トークンを AuthenticationProperties に格納するかどうかを定義します。
このプロパティは、最終的な認証 Cookie のサイズを小さくするために、既定で に |
Scope |
要求するアクセス許可の一覧を取得します。 |
SecurityTokenValidator |
ID トークンの ISecurityTokenValidator 検証に使用される を取得または設定します。 |
SignedOutCallbackPath |
ID プロバイダーからサインアウトした後にユーザー エージェントが返されるアプリケーションのベース パス内の要求パス。 |
SignInScheme |
認証が成功した後にユーザーの ID を保持するミドルウェアに対応する認証スキームを取得または設定します。 この値は、通常、Startup クラスに登録されている Cookie ミドルウェアに対応します。 省略すると、 SignInScheme がフォールバック値として使用されます。 (継承元 RemoteAuthenticationOptions) |
SignOutScheme |
SignOutPath の SignOut で使用する認証スキーム。 これが設定されていない場合は、SignInScheme が使用されます。 |
SkipUnrecognizedRequests |
CallbackPath への要求が他のコンポーネントに対して行われる可能性があるかどうかを示します。 有効にすると、ミドルウェアは OpenIdConnect 認証応答を含まない要求を経由して渡します。 これを無効にし、CallbackPath を専用エンドポイントに設定すると、エラー処理が向上する可能性があります。 この機能は、既定では無効になっています。 |
StateDataFormat |
ミドルウェアによって処理されるデータの保護に使用される種類を取得または設定します。 |
StringDataFormat |
ミドルウェアで使用される文字列をセキュリティで保護するために使用される型を取得または設定します。 |
SystemClock |
For testing purposes only. |
SystemClock |
For testing purposes only. (継承元 AuthenticationOptions) |
TokenValidationParameters |
ID トークンの検証に使用されるパラメーターを取得または設定します。 |
UseTokenLifetime |
認証セッションの有効期間 (Cookie など) が認証トークンの有効期間と一致する必要があることを示します。 有効期間情報がトークンから得られない場合は、一般的なセッションの有効期間が使用されます。 この機能は、既定では無効になっています。 |