Share via


OpenIdConnectOptions 클래스

정의

에 대한 구성 옵션입니다.OpenIdConnectHandler

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions
public class OpenIdConnectOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions
type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions
Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions
상속

생성자

OpenIdConnectOptions()

OpenIdConnectOptions를 초기화합니다.

속성

AccessDeniedPath

사용자가 원격 서버에서 요청한 권한 부여 요청을 승인하지 않는 경우 사용자 에이전트가 리디렉션되는 선택적 경로를 가져오거나 설정합니다. 이 속성은 기본적으로 설정 되지 않았습니다. 이 경우 원격 권한 부여 서버에서 access_denied 응답을 반환하는 경우 예외가 throw됩니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
AuthenticationMethod

사용자 에이전트를 ID 공급자로 리디렉션하는 데 사용되는 메서드를 가져오거나 설정합니다.

Authority

OpenIdConnect 호출 시 사용할 Authority를 가져오거나 설정합니다.

AutomaticRefreshInterval

자동 메타데이터 새로 고침이 발생하는 빈도를 가져오거나 설정합니다.

Backchannel

원격 ID 공급자와 통신하는 데 사용됩니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
BackchannelHttpHandler

원격 ID 공급자와 통신하는 데 사용되는 HttpMessageHandler입니다. 값을 WebRequestHandler로 다운캐스트할 수 있는 경우 외에는 동시에 BackchannelCertificateValidator로는 설정할 수 없습니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
BackchannelTimeout

원격 ID 공급자와의 백 채널 통신에 대한 시간 제한 값을 밀리초 단위로 가져오거나 설정합니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
CallbackPath

사용자 에이전트가 반환될 응용 프로그램의 기본 경로 내의 요청 경로입니다. 이 요청이 도착하면 미들웨어가 처리합니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
ClaimActions

json 사용자 데이터에서 값을 선택하고 클레임을 만드는 데 사용되는 클레임 작업의 컬렉션입니다.

ClaimsIssuer

생성된 클레임에 사용해야 하는 발급자를 가져오거나 설정합니다.

(다음에서 상속됨 AuthenticationSchemeOptions)
ClientId

'client_id'를 가져오거나 설정합니다.

ClientSecret

'client_secret'을 가져오거나 설정합니다.

Configuration

개발자가 직접 제공하는 구성입니다. 제공된 경우 MetadataAddress 및 Backchannel 속성이 사용되지 않습니다. 이 정보는 요청 처리 중 업데이트되지 않아야 합니다.

ConfigurationManager

메타데이터에서 구성을 검색 및 캐싱하고 새로 고칩니다. 제공되지 않은 경우 MetadataAddress 및 Backchannel 속성을 사용하여 만듭니다.

CorrelationCookie

쿠키가 응답에 추가되기 전에 상관 관계 쿠키를 만드는 데 사용되는 설정을 결정합니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
DataProtectionProvider

데이터를 보호하는 데 사용되는 형식을 가져오거나 설정합니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
DisableTelemetry

원격 분석을 사용하지 않도록 설정해야 하는지 여부를 나타냅니다. 이 기능을 사용하도록 설정하면 Microsoft IdentityModel 패키지의 어셈블리 버전이 권한 부여/로그아웃 요청 매개 변수로 원격 OpenID Connect 공급자로 전송됩니다.

Events

OpenIdConnect 메시지를 처리할 때 알릴 을 가져오거나 설정합니다 OpenIdConnectEvents .

EventsType

설정된 경우 는 속성 대신 이벤트 instance 가져오기 위해 서비스 유형으로 사용됩니다.

(다음에서 상속됨 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)
GetClaimsFromUserInfoEndpoint

토큰 엔드포인트에서 받은 id_token ID를 만든 후 처리기가 사용자 정보 엔드포인트로 이동하여 추가 클레임을 검색해야 하는지 여부를 설정하는 부울입니다. 기본값은 'false'입니다.

MapInboundClaims

SecurityTokenValidator의 JwtSecurityTokenHandler 기본 instance 속성을 가져오거나 설정 MapInboundClaims 하며, 의 기본 instance JsonWebTokenHandler TokenHandler에서 유효성을 검사JwtSecurityToken할 때 추출되는 클레임 형식을 매핑할지 여부를 결정할 때 사용됩니다.

true로 설정된 경우 클레임 유형은 이 매핑을 사용하여 번역한 후 JSON 클레임 'name'으로 설정됩니다. 그렇지 않으면 매핑이 발생하지 않습니다.

기본값은 true입니다.

MaxAge

'max_age'을 가져오거나 설정합니다. 설정하면 인증 요청과 함께 'max_age' 매개 변수가 전송됩니다. ID 공급자가 지정된 시간 내에 사용자를 적극적으로 인증하지 않은 경우 사용자에게 다시 인증하라는 메시지가 표시됩니다. 기본적으로 max_age 지정되지 않습니다.

MetadataAddress

메타데이터를 가져오기 위한 검색 엔드포인트를 가져오거나 설정합니다.

NonceCookie

쿠키가 응답에 추가되기 전에 nonce 쿠키를 만드는 데 사용되는 설정을 결정합니다.

Prompt

'prompt'를 가져오거나 설정합니다.

ProtocolValidator

수신된 OpenIdConnectProtocolValidator 'id_token'이 유효한지 확인하는 데 사용되는 를 가져오거나 설정합니다. http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation

RefreshInterval

검색에 실패했거나 새로 고침이 명시적으로 요청된 경우 검색 사이의 최소 시간을 가져오거나 설정합니다.

RefreshOnIssuerKeyNotFound

SecurityTokenSignatureKeyNotFoundException 후에 메타데이터 새로 고침을 시도해야 하는지 여부를 가져오거나 설정합니다. 서명 키 롤오버가 발생할 경우 자동 복구를 허용합니다. 이 옵션은 기본적으로 사용하도록 설정되어 있습니다.

RemoteAuthenticationTimeout

인증 흐름을 완료하기 위한 시간 제한을 가져오거나 설정합니다(기본적으로 15분).

(다음에서 상속됨 RemoteAuthenticationOptions)
RemoteSignOutPath

이 경로에서 수신된 요청으로 인해 처리기가 SignOutScheme을 사용하여 SignOut을 호출합니다.

RequireHttpsMetadata

메타데이터 주소 또는 권한에 HTTPS가 필요한지 여부를 가져오거나 설정합니다. 기본값은 true입니다. 개발 환경에서만 사용하지 않도록 설정해야 합니다.

Resource

'resource'를 가져오거나 설정합니다.

ResponseMode

'response_mode'을 가져오거나 설정합니다.

ResponseType

'response_type'을 가져오거나 설정합니다.

ReturnUrlParameter

원격 챌린지가 액세스 거부 페이지까지 트리거되기 전에 사용자의 원래 위치를 전달하는 데 사용되는 매개 변수의 이름을 가져오거나 설정합니다. 이 속성은 가 명시적으로 지정된 경우에만 사용됩니다 AccessDeniedPath .

(다음에서 상속됨 RemoteAuthenticationOptions)
SaveTokens

성공적인 권한 부여 후에 액세스 및 새로 고침 토큰을 에 AuthenticationProperties 저장할지 여부를 정의합니다. 이 속성은 최종 인증 쿠키의 크기를 줄이기 위해 기본적으로 로 설정 false 됩니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
Scope

요청할 사용 권한 목록을 가져옵니다.

SecurityTokenValidator
사용되지 않음.

ID 토큰의 ISecurityTokenValidator 유효성을 검사하는 데 사용되는 를 가져오거나 설정합니다.

SignedOutCallbackPath

ID 공급자에서 로그아웃한 후 사용자 에이전트가 반환되는 애플리케이션의 기본 경로 내의 요청 경로입니다. 에서 http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogoutpost_logout_redirect_uri 참조하세요.

SignedOutRedirectUri

ID 공급자에서 애플리케이션이 로그아웃된 후 사용자 에이전트가 로 리디렉션되는 URI입니다. 리디렉션은 SignedOutCallbackPath가 호출된 후에 발생합니다.

SignInScheme

인증에 성공한 후 사용자의 ID를 유지하는 미들웨어에 해당하는 인증 체계를 가져오거나 설정합니다. 이 값은 일반적으로 Startup 클래스에 등록된 쿠키 미들웨어에 해당합니다. 생략하면 DefaultSignInScheme 가 대체 값으로 사용됩니다.

(다음에서 상속됨 RemoteAuthenticationOptions)
SignOutScheme

SignOutPath에서 SignOut과 함께 사용할 인증 체계입니다. 이 설정되지 않은 경우 SignInScheme이 사용됩니다.

SkipUnrecognizedRequests

CallbackPath에 대한 요청이 다른 구성 요소에 대한 요청일 수도 있는지를 나타냅니다. 사용하도록 설정된 경우 처리기는 OpenIdConnect 인증 응답을 포함하지 않는 요청을 통과합니다. 이를 사용하지 않도록 설정하고 CallbackPath를 전용 엔드포인트로 설정하면 더 나은 오류 처리가 될 수 있습니다. 이 옵션은 기본적으로 사용하지 않도록 설정되어 있습니다.

StateDataFormat

처리기에서 처리하는 데이터를 보호하는 데 사용되는 형식을 가져오거나 설정합니다.

StringDataFormat

처리기에서 사용하는 문자열을 보호하는 데 사용되는 형식을 가져오거나 설정합니다.

TimeProvider

테스트에 사용됩니다.

(다음에서 상속됨 AuthenticationSchemeOptions)
TokenHandler

ID 토큰의 TokenHandler 유효성을 검사하는 데 사용되는 를 가져오거나 설정합니다.

가 인 경우 UseSecurityTokenValidatorfalse대신 SecurityTokenValidator 사용됩니다.

TokenValidationParameters

ID 토큰의 유효성을 검사하는 데 사용되는 매개 변수를 가져오거나 설정합니다.

UsePkce

PKCE(코드 교환용 증명 키) 표준을 사용하거나 사용하지 않도록 설정합니다. 이 값은 가 로 ResponseType 설정된 Code경우에만 적용됩니다. https://tools.ietf.org/html/rfc7636을 참조하세요. 기본값은 true입니다.

UseSecurityTokenValidator

ID 토큰의 유효성을 검사하기 위해 또는 SecurityTokenValidator 을 사용할 TokenHandler 지 여부를 가져오거나 설정합니다.

UseTokenLifetime

인증 세션 수명(예: 쿠키)이 인증 토큰의 수명과 일치해야 했음을 나타냅니다. 토큰이 수명 정보를 제공하지 않는 경우 기본 세션 수명이 사용됩니다. 이 옵션은 기본적으로 사용하지 않도록 설정되어 있습니다.

메서드

Validate()

옵션이 유효한지 확인합니다. 상황이 정상이 아닌 경우 예외를 throw해야 합니다.

Validate(String)

옵션이 특정 구성표에 대해 유효한지 확인합니다.

(다음에서 상속됨 RemoteAuthenticationOptions)

적용 대상