OpenIdConnectHandler クラス

定義

OpenIdConnectAuthenticationMiddleware の要求ごとの認証ハンドラー。

public ref class OpenIdConnectHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<Microsoft::AspNetCore::Builder::OpenIdConnectOptions ^>
public ref class OpenIdConnectHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<Microsoft::AspNetCore::Authentication::OpenIdConnect::OpenIdConnectOptions ^>, Microsoft::AspNetCore::Authentication::IAuthenticationSignOutHandler
public class OpenIdConnectHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Builder.OpenIdConnectOptions>
public class OpenIdConnectHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler
type OpenIdConnectHandler = class
    inherit RemoteAuthenticationHandler<OpenIdConnectOptions>
type OpenIdConnectHandler = class
    inherit RemoteAuthenticationHandler<OpenIdConnectOptions>
    interface IAuthenticationSignOutHandler
    interface IAuthenticationHandler
Public Class OpenIdConnectHandler
Inherits RemoteAuthenticationHandler(Of OpenIdConnectOptions)
Public Class OpenIdConnectHandler
Inherits RemoteAuthenticationHandler(Of OpenIdConnectOptions)
Implements IAuthenticationSignOutHandler
継承
継承
実装

コンストラクター

名前 説明
OpenIdConnectHandler(HttpClient, HtmlEncoder)

OpenIdConnectAuthenticationMiddleware の要求ごとの認証ハンドラー。

OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder, ISystemClock)
古い.

OpenIdConnectHandlerの新しいインスタンスを初期化します。

OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder)

OpenIdConnectHandlerの新しいインスタンスを初期化します。

プロパティ

名前 説明
Backchannel

リモート ID プロバイダーとの通信に使用する HttpClient を取得します。

ClaimsIssuer

要求が発行されたときに使用する発行者を取得します。

(継承元 AuthenticationHandler<TOptions>)
Clock
古い.

ISystemClock を取得します。

(継承元 AuthenticationHandler<TOptions>)
Context

HttpContextを取得または設定します。

(継承元 AuthenticationHandler<TOptions>)
CurrentUri

現在の絶対 URL を取得します。

(継承元 AuthenticationHandler<TOptions>)
Events

ハンドラーは、処理が発生している特定のポイントでアプリケーション制御を提供するイベントに対してメソッドを呼び出します。 指定されていない場合は、メソッドが呼び出されたときに何も行わない既定のインスタンスが提供されます。

HtmlEncoder

HtmlEncoder を取得します。

Logger

ILogger を取得します。

(継承元 AuthenticationHandler<TOptions>)
Options

この認証ハンドラーに関連付けられているオプションを取得または設定します。

(継承元 AuthenticationHandler<TOptions>)
OptionsMonitor

オプションの変更を検出する IOptionsMonitor<TOptions> を取得します。

(継承元 AuthenticationHandler<TOptions>)
OriginalPath

認証ミドルウェアに表示されるパスを取得します。

(継承元 AuthenticationHandler<TOptions>)
OriginalPathBase

認証ミドルウェアによって表示されるパス ベースを取得します。

(継承元 AuthenticationHandler<TOptions>)
Request

現在の要求に関連付けられている HttpRequest を取得します。

(継承元 AuthenticationHandler<TOptions>)
Response

現在の要求に関連付けられている HttpResponse を取得します。

(継承元 AuthenticationHandler<TOptions>)
Scheme

この認証ハンドラーに関連付けられている AuthenticationScheme を取得または設定します。

(継承元 AuthenticationHandler<TOptions>)
SignInScheme

サインインに既定で使用される認証スキーム。

(継承元 RemoteAuthenticationHandler<TOptions>)
TimeProvider

現在の時刻 (主に単体テスト用) を取得します。

(継承元 AuthenticationHandler<TOptions>)
UrlEncoder

UrlEncoder を取得します。

(継承元 AuthenticationHandler<TOptions>)

メソッド

名前 説明
AuthenticateAsync()

現在の要求を認証します。

(継承元 AuthenticationHandler<TOptions>)
BuildRedirectUri(String)

指定した targetPathの絶対 URL を構築します。

(継承元 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)

現在の要求にチャレンジします。

(継承元 AuthenticationHandler<TOptions>)
CreateEventsAsync()

イベント インスタンスの新しいインスタンスを作成します。

ForbidAsync(AuthenticationProperties)

現在の要求を禁止します。

(継承元 AuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)

現在のリモート認証要求を関連付けるために使用される nonce を含む Cookie を生成します。

(継承元 RemoteAuthenticationHandler<TOptions>)
GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, AuthenticationTicket)

UserInfo エンドポイントにアクセスして、追加の要求を取得し、特定の ID に一意の要求を追加します。

GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, ClaimsPrincipal, AuthenticationProperties)

UserInfo エンドポイントにアクセスして、追加の要求を取得し、特定の ID に一意の要求を追加します。

HandleAccessDeniedErrorAsync(AuthenticationProperties)

派生型は、アクセス拒否エラーを処理するためにこのメソッドをオーバーライドできます。

(継承元 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()

派生型が認証を処理できるようにします。

(継承元 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()

HandleAuthenticateAsync が 1 回だけ呼び出されるようにするために使用されます。 以降の呼び出しでは、同じ認証結果が返されます。

(継承元 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()

HandleAuthenticateAsync が安全に 1 回だけ呼び出されるようにするために使用されます。 後続の呼び出しでは、同じ認証結果が返されます。 例外はすべて、例外を含む失敗した認証結果に変換されます。

(継承元 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)

401 チャレンジに応答します。 ID を取得するために、OpenIdConnect メッセージを 'ID 機関' に送信します。

HandleForbiddenAsync(AuthenticationProperties)

Forbid を処理するには、このメソッドをオーバーライドします。

(継承元 RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()

受信した OpenIdConnect メッセージを処理するために呼び出されます。

HandleRemoteSignOutAsync()

ID プロバイダーによって送信されたリモート サインアウト要求を処理します。

HandleRequestAsync()

現在の認証要求を処理します。

HandleSignOutAsync(SignOutContext)

サインアウトのためにユーザーを ID プロバイダーにリダイレクトする

HandleSignOutCallbackAsync()

セッション終了後の OpenId プロバイダーからのコールバックへの応答。

HandleUnauthorizedAsync(ChallengeContext)

401 チャレンジに応答します。 ID を取得するために、OpenIdConnect メッセージを 'ID 機関' に送信します。

InitializeAsync(AuthenticationScheme, HttpContext)

ハンドラーを初期化し、オプションを解決して検証します。

(継承元 AuthenticationHandler<TOptions>)
InitializeEventsAsync()

InitializeAsync(AuthenticationScheme, HttpContext)によって要求ごとに 1 回呼び出されるイベント オブジェクトを初期化します。

(継承元 AuthenticationHandler<TOptions>)
InitializeHandlerAsync()

ハンドラーが自身の初期化を完了するためにオプション/イベントが初期化された後に呼び出されます。

(継承元 AuthenticationHandler<TOptions>)
RedeemAuthorizationCodeAsync(OpenIdConnectMessage)

トークン エンドポイントでトークンの承認コードを使用します。

ResolveTarget(String)

この認証操作が転送されるスキームを解決します。

(継承元 AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()

現在の認証要求を HandleRequestAsync()で処理するかどうかを決定する値を取得します。

(継承元 RemoteAuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)

サインアウトのためにユーザーを ID プロバイダーにリダイレクトする

ValidateCorrelationId(AuthenticationProperties)

現在の要求が現在のリモート認証要求と関連付けられることを検証します。

(継承元 RemoteAuthenticationHandler<TOptions>)

適用対象