OpenIdConnectOptions Sınıf

Tanım

Ad Alanı:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Bütünleştirilmiş Kod:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paket:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Kaynak:

OpenIdConnectOptions.cs

Için yapılandırma seçenekleri 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

Devralma

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Oluşturucular

OpenIdConnectOptions()

Yeni bir başlatır OpenIdConnectOptions

Özellikler

AccessDeniedPath	Kullanıcı uzak sunucu tarafından istenen yetkilendirme talebini onaylamazsa, kullanıcı aracısının yeniden yönlendirildiği isteğe bağlı yolu alır veya ayarlar. Bu özellik varsayılan olarak ayarlanmaz. Bu durumda, uzaktan yetkilendirme sunucusu tarafından bir access_denied yanıtı döndürülürse bir özel durum oluşturulur. (Devralındığı yer: RemoteAuthenticationOptions)
AuthenticationMethod	Kullanıcı aracısını kimlik sağlayıcısına yönlendirmek için kullanılan yöntemi alır veya ayarlar.
Authority	OpenIdConnect çağrıları yaparken kullanılacak Yetkiliyi alır veya ayarlar.
AutomaticRefreshInterval	Otomatik meta veri yenilemenin ne sıklıkta gerçekleşmesi gerektiğini alır veya ayarlar.
Backchannel	Uzak kimlik sağlayıcısıyla iletişim kurmak için kullanılır. (Devralındığı yer: RemoteAuthenticationOptions)
BackchannelHttpHandler	Uzak kimlik sağlayıcısıyla iletişim kurmak için kullanılan HttpMessageHandler. Değer bir WebRequestHandler'a indirilemediği sürece bu, BackchannelCertificateValidator ile aynı anda ayarlanamaz. (Devralındığı yer: RemoteAuthenticationOptions)
BackchannelTimeout	Uzak kimlik sağlayıcısıyla arka kanal iletişimleri için milisaniye cinsinden zaman aşımı değerini alır veya ayarlar. (Devralındığı yer: RemoteAuthenticationOptions)
CallbackPath	Kullanıcı aracısının döndürüleceği uygulamanın temel yolu içindeki istek yolu. Ara yazılım geldiğinde bu isteği işler. (Devralındığı yer: RemoteAuthenticationOptions)
ClaimActions	Json kullanıcı verilerinden değer seçmek ve Talepler oluşturmak için kullanılan talep eylemleri koleksiyonu.
ClaimsIssuer	Oluşturulan talepler için kullanılması gereken vereni alır veya ayarlar (Devralındığı yer: AuthenticationSchemeOptions)
ClientId	'client_id' alır veya ayarlar.
ClientSecret	'client_secret' alır veya ayarlar.
Configuration	Yapılandırma doğrudan geliştirici tarafından sağlanır. Sağlanırsa MetadataAddress ve Backchannel özellikleri kullanılmaz. Bu bilgiler istek işleme sırasında güncelleştirilmemelidir.
ConfigurationManager	Meta verilerden yapılandırmayı almak, önbelleğe almak ve yenilemekten sorumludur. Sağlanmazsa MetadataAddress ve Backchannel özellikleri kullanılarak bir tane oluşturulur.
CorrelationCookie	Tanımlama bilgisi yanıta eklenmeden önce bağıntı tanımlama bilgisini oluşturmak için kullanılan ayarları belirler. (Devralındığı yer: RemoteAuthenticationOptions)
DataProtectionProvider	Verilerin güvenliğini sağlamak için kullanılan türü alır veya ayarlar. (Devralındığı yer: RemoteAuthenticationOptions)
DisableTelemetry	Telemetrinin devre dışı bırakılıp bırakılmayacağını gösterir. Bu özellik etkinleştirildiğinde, Microsoft IdentityModel paketlerinin derleme sürümü, yetkilendirme/oturum kapatma isteği parametresi olarak uzak OpenID Connect sağlayıcısına gönderilir.
Events	OpenIdConnect iletilerini işlerken bildirim almak için öğesini alır veya ayarlar OpenIdConnectEvents .
EventsType	Ayarlanırsa, özellik yerine Events örneğini almak için hizmet türü olarak kullanılır. (Devralındığı yer: AuthenticationSchemeOptions)
ForwardAuthenticate	Ayarlanırsa, bu şemanın AuthenticateAsync çağrılarını iletmesi gereken hedef düzeni belirtir. Örneğin Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); İletmeyi devre dışı bırakmak ve normal işlemeye izin vermek için hedefi geçerli şemaya ayarlayın. (Devralındığı yer: AuthenticationSchemeOptions)
ForwardChallenge	Ayarlanırsa, bu şemanın ChallengeAsync çağrılarını iletmesi gereken hedef düzeni belirtir. Örneğin Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); İletmeyi devre dışı bırakmak ve normal işlemeye izin vermek için hedefi geçerli şemaya ayarlayın. (Devralındığı yer: AuthenticationSchemeOptions)
ForwardDefault	Ayarlanırsa, kimlik doğrulama işleyicilerinin varsayılan olarak tüm kimlik doğrulama işlemlerinin iletilmesi gereken bir varsayılan şema belirtir. Varsayılan iletme mantığı önce en belirli ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut ayarını, ardından ForwardDefaultSelector'ı ve ardından ForwardDefault'u denetler. null olmayan ilk sonuç, iletilecek hedef düzen olarak kullanılır. (Devralındığı yer: AuthenticationSchemeOptions)
ForwardDefaultSelector	Kimlik doğrulama işleyicilerinin tüm kimlik doğrulama işlemlerini varsayılan olarak 'a iletmesi gereken geçerli istek için varsayılan bir düzen seçmek için kullanılır. Varsayılan iletme mantığı önce en belirli ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut ayarını, ardından ForwardDefaultSelector'ı ve ardından ForwardDefault'u denetler. null olmayan ilk sonuç, iletilecek hedef düzen olarak kullanılır. (Devralındığı yer: AuthenticationSchemeOptions)
ForwardForbid	Ayarlanırsa, bu şemanın ForbidAsync çağrılarını iletmesi gereken hedef düzeni belirtir. Örneğin Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); İletmeyi devre dışı bırakmak ve normal işlemeye izin vermek için hedefi geçerli şemaya ayarlayın. (Devralındığı yer: AuthenticationSchemeOptions)
ForwardSignIn	Ayarlanırsa, bu şemanın SignInAsync çağrılarını iletmesi gereken hedef düzeni belirtir. Örneğin Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); İletmeyi devre dışı bırakmak ve normal işlemeye izin vermek için hedefi geçerli şemaya ayarlayın. (Devralındığı yer: AuthenticationSchemeOptions)
ForwardSignOut	Ayarlanırsa, bu şemanın SignOutAsync çağrılarını iletmesi gereken hedef düzeni belirtir. Örneğin Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); İletmeyi devre dışı bırakmak ve normal işlemeye izin vermek için hedefi geçerli şemaya ayarlayın. (Devralındığı yer: AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	İşleyicinin ek talepleri almak için kullanıcı bilgileri uç noktasına gidip gitmeyeceğini veya belirteç uç noktasından alınan id_token kimlik oluşturduktan sonra gitmeyeceğini ayarlamak için Boole değeri. Varsayılan değer 'false'tur.
MapInboundClaims	Bir doğrulanırken JwtSecurityTokenayıklanan talep türlerinin MapInboundClaimsJwtSecurityTokenHandler eşlenip eşlenmeyeceğini belirlerken kullanılan SecurityTokenValidator'da ve TokenHandler'da varsayılan örneğinde JsonWebTokenHandler özelliğini alır veya ayarlar. Bu true olarak ayarlanırsa, Talep Türü bu eşleme kullanılarak çevrildikten sonra JSON talebi 'name' olarak ayarlanır. Aksi takdirde eşleme gerçekleşmez. Varsayılan değer true şeklindedir.
MaxAge	'max_age' alır veya ayarlar. Ayarlanırsa, kimlik doğrulama isteğiyle birlikte 'max_age' parametresi gönderilir. Kimlik sağlayıcısı belirtilen süre içinde kullanıcının kimliğini etkin bir şekilde doğrulamadıysa, kullanıcıdan yeniden kimlik doğrulaması istenir. Varsayılan olarak hiçbir max_age belirtilmez.
MetadataAddress	Meta verileri almak için bulma uç noktasını alır veya ayarlar
NonceCookie	Tanımlama bilgisi yanıta eklenmeden önce nonce tanımlama bilgisini oluşturmak için kullanılan ayarları belirler.
Prompt	'İstemi' alır veya ayarlar.
ProtocolValidator	Alınan 'id_token' her biri için geçerli olduğundan emin olmak için kullanılan 'ı alır veya ayarlar OpenIdConnectProtocolValidator : http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	Alma işleminin başarısız olması veya bir yenilemenin açıkça isteniyor olması durumunda almalar arasındaki en düşük süreyi alır veya ayarlar.
RefreshOnIssuerKeyNotFound	SecurityTokenSignatureKeyNotFoundException sonrasında meta veri yenileme girişiminde bulunup bulunmaması gerektiğini alır veya ayarlar. Bu, imza anahtarı geçişi durumunda otomatik kurtarma sağlar. Bu, varsayılan olarak etkindir.
RemoteAuthenticationTimeout	Kimlik doğrulama akışını tamamlamak için zaman sınırını alır veya ayarlar (varsayılan olarak 15 dakika). (Devralındığı yer: RemoteAuthenticationOptions)
RemoteSignOutPath	Bu yolda alınan istekler, işleyicinin SignOutScheme kullanarak SignOut'un çağrılmasına neden olur.
RequireHttpsMetadata	Meta veri adresi veya yetkilisi için HTTPS gerekliyse alır veya ayarlar. Varsayılan değer true'dur. Bu yalnızca geliştirme ortamlarında devre dışı bırakılmalıdır.
Resource	'Kaynağı' alır veya ayarlar.
ResponseMode	'response_mode' alır veya ayarlar.
ResponseType	'response_type' alır veya ayarlar.
ReturnUrlParameter	Uzaktan sınama tetiklenmeden önce erişim reddedildi sayfasına kadar kullanıcının özgün konumunu iletmek için kullanılan parametrenin adını alır veya ayarlar. Bu özellik yalnızca açıkça belirtildiğinde AccessDeniedPath kullanılır. (Devralındığı yer: RemoteAuthenticationOptions)
SaveTokens	Başarılı bir yetkilendirmeden sonra erişim ve yenileme belirteçlerinin içinde AuthenticationProperties depolanıp depolanmayacağını tanımlar. Bu özellik, son kimlik doğrulama tanımlama bilgisinin boyutunu küçültmek için varsayılan olarak olarak ayarlanır false . (Devralındığı yer: RemoteAuthenticationOptions)
Scope	İstekte bulunacak izinlerin listesini alır.
SecurityTokenValidator	Geçersiz. Kimlik belirteçlerini doğrulamak için kullanılan öğesini ISecurityTokenValidator alır veya ayarlar.
SignedOutCallbackPath	Kimlik sağlayıcısında oturum kapatıldıktan sonra kullanıcı aracısının döndürüleceği uygulamanın temel yolundaki istek yolu. bkz. uygulamasından http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogoutpost_logout_redirect_uri.
SignedOutRedirectUri	Kimlik sağlayıcısında uygulama oturumu kapatıldıktan sonra kullanıcı aracısının yeniden yönlendirileceği uri. Yeniden yönlendirme, SignedOutCallbackPath çağrıldıktan sonra gerçekleşir.
SignInScheme	Başarılı bir kimlik doğrulamasından sonra kullanıcının kimliğini kalıcı hale getirmekle sorumlu ara yazılıma karşılık gelen kimlik doğrulama düzenini alır veya ayarlar. Bu değer genellikle Başlangıç sınıfında kayıtlı bir tanımlama bilgisi ara yazılımına karşılık gelir. Atlandığında, DefaultSignInScheme geri dönüş değeri olarak kullanılır. (Devralındığı yer: RemoteAuthenticationOptions)
SignOutScheme	SignOutPath'te SignOut ile kullanılacak Kimlik Doğrulama Düzeni. Bu ayarlanmadıysa SignInScheme kullanılır.
SkipUnrecognizedRequests	CallbackPath isteklerinin diğer bileşenler için de olup olmadığını gösterir. Etkinleştirilirse, işleyici OpenIdConnect kimlik doğrulama yanıtlarını içermeyen istekleri geçirir. Bunu devre dışı bırakmak ve CallbackPath'i ayrılmış bir uç noktaya ayarlamak daha iyi hata işleme sağlayabilir. Bu, varsayılan olarak devre dışıdır.
StateDataFormat	İşleyici tarafından işlenen verilerin güvenliğini sağlamak için kullanılan türü alır veya ayarlar.
StringDataFormat	İşleyici tarafından kullanılan dizelerin güvenliğini sağlamak için kullanılan türü alır veya ayarlar.
TimeProvider	Test için kullanılır. (Devralındığı yer: AuthenticationSchemeOptions)
TokenHandler	Kimlik belirteçlerini doğrulamak için kullanılan öğesini TokenHandler alır veya ayarlar. bu, yerine UseSecurityTokenValidatorfalsekullanılırSecurityTokenValidator.
TokenValidationParameters	Kimlik belirteçlerini doğrulamak için kullanılan parametreleri alır veya ayarlar.
UsePkce	Kod Değişimi (PKCE) standardı için Proof Key kullanımını etkinleştirir veya devre dışı bırakır. Bu yalnızca olarak ayarlandığında CodegeçerlidirResponseType. Bkz. https://tools.ietf.org/html/rfc7636. true varsayılan değerdir.
UseSecurityTokenValidator	kimlik belirteçlerini doğrulamak için veya öğesinin TokenHandlerSecurityTokenValidator kullanılıp kullanılmayacağını alır veya ayarlar.
UseTokenLifetime	Kimlik doğrulama oturumunun ömrünün (ör. tanımlama bilgileri) kimlik doğrulama belirtecininkiyle eşleşmesi gerektiğini gösterir. Belirteç yaşam süresi bilgilerini sağlamıyorsa normal oturum ömrü kullanılır. Bu, varsayılan olarak devre dışıdır.

Yöntemler

Validate()	Seçeneklerin geçerli olup olmadığını denetleyin. her şey yolunda değilse bir özel durum oluşturmalıdır.
Validate(String)	Seçeneklerin belirli bir düzen için geçerli olup olmadığını denetler (Devralındığı yer: RemoteAuthenticationOptions)