OAuthOptions クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
OAuthMiddleware<TOptions> の構成オプション。
public ref class OAuthOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptionspublic class OAuthOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptionstype OAuthOptions = class
inherit RemoteAuthenticationOptionsPublic Class OAuthOptions
Inherits RemoteAuthenticationOptions- 継承
- 派生
コンストラクター
| OAuthOptions() |
OAuthMiddleware<TOptions> の構成オプション。 |
プロパティ
| AuthenticationScheme |
オプションの AuthenticationScheme は、特定の認証スキームの論理名に対応します。 同じ種類の認証ミドルウェアを複数回パイプラインで使用するために、異なる値を割り当てることができます。 (継承元 AuthenticationOptions) |
| AuthorizationEndpoint |
クライアントが認証にリダイレクトされる URI を取得または設定します。 |
| 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 |
プロバイダー割り当てクライアント ID を取得または設定します。 |
| ClientSecret |
プロバイダー割り当てクライアント シークレットを取得または設定します。 |
| Description |
アプリケーションから使用可能な、認証の種類に関する追加情報。 (継承元 AuthenticationOptions) |
| DisplayName |
ユーザーがサインイン ユーザー インターフェイスに表示できるテキストを取得または設定します。 (継承元 RemoteAuthenticationOptions) |
| Events |
認証イベントの処理に使用される を IOAuthEvents 取得または設定します。 |
| RemoteAuthenticationTimeout |
認証フローを完了するための時間制限を取得または設定します (既定では 15 分)。 (継承元 RemoteAuthenticationOptions) |
| SaveTokens |
承認が成功した後、アクセス トークンと更新トークンを AuthenticationProperties に格納するかどうかを定義します。
このプロパティは、最終的な認証 Cookie のサイズを小さくするために、既定で に |
| Scope |
要求するアクセス許可の一覧を取得します。 |
| SignInScheme |
認証が成功した後にユーザーの ID を保持するミドルウェアに対応する認証スキームを取得または設定します。 この値は、通常、Startup クラスに登録されている Cookie ミドルウェアに対応します。 省略すると、 SignInScheme がフォールバック値として使用されます。 (継承元 RemoteAuthenticationOptions) |
| StateDataFormat |
ミドルウェアによって処理されるデータの保護に使用される種類を取得または設定します。 |
| SystemClock |
For testing purposes only. |
| SystemClock |
For testing purposes only. (継承元 AuthenticationOptions) |
| TokenEndpoint |
ミドルウェアが OAuth トークンを交換するためにアクセスする URI を取得または設定します。 |
| UserInformationEndpoint |
ミドルウェアがユーザー情報を取得するためにアクセスする URI を取得または設定します。 この値は既定の実装では使用されません。これは、IOAuthAuthenticationEvents.Authenticated または OAuthAuthenticationHandler.CreateTicketAsync のカスタム実装で使用されます。 |