FacebookOptions クラス

定義

FacebookHandler の構成オプション。

public ref class FacebookOptions : Microsoft::AspNetCore::Authentication::OAuth::OAuthOptions
public class FacebookOptions : Microsoft.AspNetCore.Authentication.OAuth.OAuthOptions
type FacebookOptions = class
    inherit OAuthOptions
Public Class FacebookOptions
Inherits OAuthOptions
継承

コンストラクター

FacebookOptions()

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

プロパティ

AccessDeniedPath

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

(継承元 RemoteAuthenticationOptions)
AppId

Facebook に割り当てられたアプリ ID を取得または設定します。

AppSecret

Facebook に割り当てられたアプリ シークレットを取得または設定します。

AuthorizationEndpoint

クライアントが認証にリダイレクトされる URI を取得または設定します。

(継承元 OAuthOptions)
Backchannel

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

(継承元 RemoteAuthenticationOptions)
BackchannelHttpHandler

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

(継承元 RemoteAuthenticationOptions)
BackchannelTimeout

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

(継承元 RemoteAuthenticationOptions)
CallbackPath

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

(継承元 RemoteAuthenticationOptions)
ClaimActions

json ユーザー データから値を選択し、要求を作成するために使用される要求アクションのコレクション。

(継承元 OAuthOptions)
ClaimsIssuer

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

(継承元 AuthenticationSchemeOptions)
ClientId

プロバイダー割り当てクライアント ID を取得または設定します。

(継承元 OAuthOptions)
ClientSecret

プロバイダー割り当てクライアント シークレットを取得または設定します。

(継承元 OAuthOptions)
CorrelationCookie

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

(継承元 RemoteAuthenticationOptions)
DataProtectionProvider

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

(継承元 RemoteAuthenticationOptions)
Events

認証イベントの処理に使用される を OAuthEvents 取得または設定します。

(継承元 OAuthOptions)
EventsType

が設定されている場合は、 プロパティの代わりに Events インスタンスを取得するためのサービスの種類として が使用されます。

(継承元 AuthenticationSchemeOptions)
Fields

UserInformationEndpoint から取得するフィールドの一覧。

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 分)。

(継承元 RemoteAuthenticationOptions)
ReturnUrlParameter

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

(継承元 RemoteAuthenticationOptions)
SaveTokens

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

(継承元 RemoteAuthenticationOptions)
Scope

要求するアクセス許可の一覧を取得します。

(継承元 OAuthOptions)
SendAppSecretProof

を生成して Facebook API 呼び出しで送信するかどうかを取得または設定 appsecret_proof します。

SignInScheme

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

(継承元 RemoteAuthenticationOptions)
StateDataFormat

ミドルウェアによって処理されるデータの保護に使用される種類を取得または設定します。

(継承元 OAuthOptions)
TimeProvider

テストに使用されます。

(継承元 AuthenticationSchemeOptions)
TokenEndpoint

ミドルウェアが OAuth トークンを交換するためにアクセスする URI を取得または設定します。

(継承元 OAuthOptions)
UsePkce

Proof Key for Code Exchange (PKCE) 標準の使用を有効または無効にします。 「https://tools.ietf.org/html/rfc7636」を参照してください。 既定値は false ですが、派生ハンドラーがプロバイダーでサポートされている場合は、これを有効にする必要があります。

(継承元 OAuthOptions)
UserInformationEndpoint

ミドルウェアがユーザー情報を取得するためにアクセスする URI を取得または設定します。 この値は、既定の実装では使用されません。これは のカスタム実装で使用されます OnCreatingTicket

(継承元 OAuthOptions)

メソッド

Validate()

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

Validate(String)

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

(継承元 RemoteAuthenticationOptions)

適用対象