FacebookOptions クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
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) |
AdditionalAuthorizationParameters |
承認要求に含まれる追加のパラメーターを取得します。 (継承元 OAuthOptions) |
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 に格納するかどうかを定義します。
このプロパティは既定で |
Scope |
要求するアクセス許可の一覧を取得します。 (継承元 OAuthOptions) |
SendAppSecretProof |
Facebook API 呼び出しで |
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を参照してください。
既定値は |
UserInformationEndpoint |
ミドルウェアがユーザー情報を取得するためにアクセスする URI を取得または設定します。 この値は、既定の実装では使用されず、OnCreatingTicketのカスタム実装で使用されます。 (継承元 OAuthOptions) |
メソッド
Validate() |
オプションが有効であることを確認します。 問題がなければ例外をスローする必要があります。 |
Validate(String) |
オプションが特定のスキームに対して有効であることを確認します (継承元 RemoteAuthenticationOptions) |