RemoteAuthenticationOptions クラス

定義

によって使用されるオプションが RemoteAuthenticationHandler<TOptions>含まれます。

public ref class RemoteAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions
public class RemoteAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions
type RemoteAuthenticationOptions = class
    inherit AuthenticationSchemeOptions
Public Class RemoteAuthenticationOptions
Inherits AuthenticationSchemeOptions
継承
RemoteAuthenticationOptions
派生

コンストラクター

RemoteAuthenticationOptions()

新しい RemoteAuthenticationOptions を初期化します。

プロパティ

AccessDeniedPath

ユーザーがリモート サーバーから要求された承認要求を承認しない場合に、ユーザー エージェントがリダイレクトされる省略可能なパスを取得または設定します。 このプロパティは、既定では設定されていません。 この場合、リモート承認サーバーからaccess_denied応答が返されると、例外がスローされます。

Backchannel

リモート ID プロバイダーとの通信に使用されます。

BackchannelHttpHandler

リモート ID プロバイダーとの通信に使用される HttpMessageHandler。 値を WebRequestHandler にダウンキャストできない場合、これを BackchannelCertificateValidator と同時に設定することはできません。

BackchannelTimeout

リモート ID プロバイダーとのバック チャネル通信のタイムアウト値をミリ秒単位で取得または設定します。

CallbackPath

ユーザー エージェントが返される、アプリケーションの基本パス内の要求パス。 この要求が到着するとミドルウェアが処理します。

ClaimsIssuer

作成されるすべての要求に使用する発行者を取得または設定します。

(継承元 AuthenticationSchemeOptions)
CorrelationCookie

Cookie が応答に追加される前に、関連付け Cookie の作成に使用される設定を決定します。

DataProtectionProvider

データのセキュリティ保護に使用される型を取得または設定します。

Events

リモート認証イベントのサブスクライブを許可する値を取得または設定します。

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)
RemoteAuthenticationTimeout

認証フローを完了するための時間制限を取得または設定します (既定では 15 分)。

ReturnUrlParameter

アクセスが拒否されたページまでリモート チャレンジがトリガーされる前に、ユーザーの元の場所を伝えるために使用されるパラメーターの名前を取得または設定します。 このプロパティは、 が明示的に指定されている場合 AccessDeniedPath にのみ使用されます。

SaveTokens

承認が成功した後、アクセス トークンと更新トークンを AuthenticationProperties に格納するかどうかを定義します。 このプロパティは、最終的な認証 Cookie のサイズを小さくするために、既定で に false 設定されています。

SignInScheme

認証が成功した後にユーザーの ID を保持するミドルウェアに対応する認証スキームを取得または設定します。 この値は、通常、Startup クラスに登録されている Cookie ミドルウェアに対応します。 省略すると、 DefaultSignInScheme がフォールバック値として使用されます。

TimeProvider

テストに使用されます。

(継承元 AuthenticationSchemeOptions)

メソッド

Validate()

オプションが有効であることを確認します。 問題がなければ例外をスローする必要があります。

Validate(String)

オプションが特定のスキームに対して有効であることを確認します

Validate(String)

オプションが特定のスキームに対して有効であることを確認します

(継承元 AuthenticationSchemeOptions)

適用対象