OpenIdConnectOptions Kelas

Definisi

Ruang nama:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Rakitan:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Paket:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Sumber:

OpenIdConnectOptions.cs

Opsi konfigurasi untuk 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

Warisan

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

Konstruktor

OpenIdConnectOptions()

Menginisialisasi OpenIdConnectOptions baru

Properti

AccessDeniedPath	Mendapatkan atau mengatur jalur opsional yang dialihkan agen pengguna jika pengguna tidak menyetujui permintaan otorisasi yang diminta oleh server jarak jauh. Properti ini tidak diatur secara default. Dalam hal ini, pengecualian dilemparkan jika respons access_denied dikembalikan oleh server otorisasi jarak jauh. (Diperoleh dari RemoteAuthenticationOptions)
AuthenticationMethod	Mendapatkan atau mengatur metode yang digunakan untuk mengalihkan agen pengguna ke IdP.
Authority	Mendapatkan atau mengatur Otoritas yang akan digunakan saat melakukan panggilan OpenIdConnect.
AutomaticRefreshInterval	Mendapatkan atau mengatur seberapa sering refresh metadata otomatis harus terjadi.
Backchannel	Digunakan untuk berkomunikasi dengan penyedia identitas jarak jauh. (Diperoleh dari RemoteAuthenticationOptions)
BackchannelHttpHandler	HttpMessageHandler digunakan untuk berkomunikasi dengan penyedia identitas jarak jauh. Ini tidak dapat diatur pada saat yang sama dengan BackchannelCertificateValidator kecuali nilai dapat di-downcast ke WebRequestHandler. (Diperoleh dari RemoteAuthenticationOptions)
BackchannelTimeout	Mendapatkan atau menetapkan nilai batas waktu dalam milidetik untuk komunikasi saluran kembali dengan penyedia identitas jarak jauh. (Diperoleh dari RemoteAuthenticationOptions)
CallbackPath	Jalur permintaan dalam jalur dasar aplikasi tempat agen pengguna akan dikembalikan. Middleware akan memproses permintaan ini ketika tiba. (Diperoleh dari RemoteAuthenticationOptions)
ClaimActions	Kumpulan tindakan klaim yang digunakan untuk memilih nilai dari data pengguna json dan membuat Klaim.
ClaimsIssuer	Mendapatkan atau mengatur penerbit yang harus digunakan untuk klaim apa pun yang dibuat (Diperoleh dari AuthenticationSchemeOptions)
ClientId	Mendapatkan atau mengatur 'client_id'.
ClientSecret	Mendapatkan atau mengatur 'client_secret'.
Configuration	Konfigurasi yang disediakan langsung oleh pengembang. Jika disediakan, maka properti MetadataAddress dan Backchannel tidak akan digunakan. Informasi ini tidak boleh diperbarui selama pemrosesan permintaan.
ConfigurationManager	Bertanggung jawab untuk mengambil, membuat cache, dan menyegarkan konfigurasi dari metadata. Jika tidak disediakan, maka akan dibuat menggunakan properti MetadataAddress dan Backchannel.
CorrelationCookie	Menentukan pengaturan yang digunakan untuk membuat cookie korelasi sebelum cookie ditambahkan ke respons. (Diperoleh dari RemoteAuthenticationOptions)
DataProtectionProvider	Mendapatkan atau mengatur jenis yang digunakan untuk mengamankan data. (Diperoleh dari RemoteAuthenticationOptions)
DisableTelemetry	Menunjukkan apakah telemetri harus dinonaktifkan. Ketika fitur ini diaktifkan, versi rakitan paket Microsoft IdentityModel dikirim ke penyedia OpenID Connect jarak jauh sebagai parameter permintaan otorisasi/keluar.
Events	Mendapatkan atau mengatur OpenIdConnectEvents untuk memberi tahu saat memproses pesan OpenIdConnect.
EventsType	Jika diatur, akan digunakan sebagai jenis layanan untuk mendapatkan instans Peristiwa alih-alih properti . (Diperoleh dari AuthenticationSchemeOptions)
ForwardAuthenticate	Jika diatur, ini menentukan skema target tempat skema ini harus meneruskan panggilan AuthenticateAsync. Misalnya Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Atur target ke skema saat ini untuk menonaktifkan penerusan dan memungkinkan pemrosesan normal. (Diperoleh dari AuthenticationSchemeOptions)
ForwardChallenge	Jika diatur, ini menentukan skema target yang harus diteruskan oleh skema ini untuk meneruskan panggilan ChallengeAsync. Misalnya Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Atur target ke skema saat ini untuk menonaktifkan penerusan dan memungkinkan pemrosesan normal. (Diperoleh dari AuthenticationSchemeOptions)
ForwardDefault	Jika diatur, ini menentukan skema default yang harus diteruskan oleh handler autentikasi ke semua operasi autentikasi secara default. Logika penerusan default akan memeriksa pengaturan ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut yang paling spesifik terlebih dahulu, diikuti dengan memeriksa ForwardDefaultSelector, diikuti oleh ForwardDefault. Hasil non-null pertama akan digunakan sebagai skema target untuk diteruskan. (Diperoleh dari AuthenticationSchemeOptions)
ForwardDefaultSelector	Digunakan untuk memilih skema default untuk permintaan saat ini yang harus diteruskan oleh penangan autentikasi ke semua operasi autentikasi secara default. Logika penerusan default akan memeriksa pengaturan ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut yang paling spesifik terlebih dahulu, diikuti dengan memeriksa ForwardDefaultSelector, diikuti oleh ForwardDefault. Hasil non-null pertama akan digunakan sebagai skema target untuk diteruskan. (Diperoleh dari AuthenticationSchemeOptions)
ForwardForbid	Jika diatur, ini menentukan skema target tempat skema ini harus meneruskan panggilan ForbidAsync. Misalnya Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Atur target ke skema saat ini untuk menonaktifkan penerusan dan memungkinkan pemrosesan normal. (Diperoleh dari AuthenticationSchemeOptions)
ForwardSignIn	Jika diatur, ini menentukan skema target tempat skema ini harus meneruskan panggilan SignInAsync. Misalnya Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Atur target ke skema saat ini untuk menonaktifkan penerusan dan memungkinkan pemrosesan normal. (Diperoleh dari AuthenticationSchemeOptions)
ForwardSignOut	Jika diatur, ini menentukan skema target tempat skema ini harus meneruskan panggilan SignOutAsync. Misalnya Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Atur target ke skema saat ini untuk menonaktifkan penerusan dan memungkinkan pemrosesan normal. (Diperoleh dari AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	Boolean untuk mengatur apakah handler harus masuk ke titik akhir info pengguna untuk mengambil klaim tambahan atau tidak setelah membuat identitas dari id_token diterima dari titik akhir token. Defaultnya adalah 'false'.
MapInboundClaims	Mendapatkan atau mengatur properti MapInboundClaims pada instans default JwtSecurityTokenHandler di SecurityTokenValidator dan instans default JsonWebTokenHandler di TokenHandler, yang digunakan saat menentukan apakah akan memetakan jenis klaim yang diekstrak atau tidak saat memvalidasi JwtSecurityToken. Jika ini diatur ke true, Jenis Klaim diatur ke 'nama' klaim JSON setelah diterjemahkan menggunakan pemetaan ini. Jika tidak, tidak ada pemetaan yang terjadi. Nilai defaultnya adalah true.
MaxAge	Mendapatkan atau mengatur 'max_age'. Jika mengatur parameter 'max_age' akan dikirim dengan permintaan autentikasi. Jika penyedia identitas belum secara aktif mengautentikasi pengguna dalam jangka waktu yang ditentukan, pengguna akan diminta untuk mengautentikasi ulang. Secara default tidak ada max_age yang ditentukan.
MetadataAddress	Mendapatkan atau mengatur titik akhir penemuan untuk mendapatkan metadata
NonceCookie	Menentukan pengaturan yang digunakan untuk membuat cookie nonce sebelum cookie ditambahkan ke respons.
Prompt	Mendapatkan atau mengatur 'prompt'.
ProtocolValidator	Mendapatkan atau mengatur OpenIdConnectProtocolValidator yang digunakan untuk memastikan bahwa 'id_token' yang diterima valid per: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation
RefreshInterval	Mendapatkan atau mengatur waktu minimum antara pengambilan, jika pengambilan gagal, atau bahwa refresh diminta secara eksplisit.
RefreshOnIssuerKeyNotFound	Mendapatkan atau mengatur apakah refresh metadata harus dicoba setelah SecurityTokenSignatureKeyNotFoundException. Ini memungkinkan pemulihan otomatis jika terjadi rollover kunci tanda tangan. Ini diaktifkan secara default.
RemoteAuthenticationTimeout	Mendapatkan atau mengatur batas waktu untuk menyelesaikan alur autentikasi (15 menit secara default). (Diperoleh dari RemoteAuthenticationOptions)
RemoteSignOutPath	Permintaan yang diterima pada jalur ini akan menyebabkan handler memanggil SignOut menggunakan SignOutScheme.
RequireHttpsMetadata	Mendapatkan atau mengatur apakah HTTPS diperlukan untuk alamat metadata atau otoritas. Defaultnya adalah true. Ini harus dinonaktifkan hanya di lingkungan pengembangan.
Resource	Mendapatkan atau mengatur 'sumber daya'.
ResponseMode	Mendapatkan atau mengatur 'response_mode'.
ResponseType	Mendapatkan atau mengatur 'response_type'.
ReturnUrlParameter	Mendapatkan atau mengatur nama parameter yang digunakan untuk menyampaikan lokasi asli pengguna sebelum tantangan jarak jauh dipicu hingga halaman akses ditolak. Properti ini hanya digunakan ketika AccessDeniedPath ditentukan secara eksplisit. (Diperoleh dari RemoteAuthenticationOptions)
SaveTokens	Menentukan apakah token akses dan refresh harus disimpan di AuthenticationProperties setelah otorisasi berhasil. Properti ini diatur ke false secara default untuk mengurangi ukuran cookie autentikasi akhir. (Diperoleh dari RemoteAuthenticationOptions)
Scope	Mendapatkan daftar izin untuk diminta.
SecurityTokenValidator	Kedaluwarsa. Mendapatkan atau mengatur ISecurityTokenValidator yang digunakan untuk memvalidasi token identitas.
SignedOutCallbackPath	Jalur permintaan dalam jalur dasar aplikasi tempat agen pengguna akan dikembalikan setelah keluar dari penyedia identitas. Lihat post_logout_redirect_uri dari http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout.
SignedOutRedirectUri	Uri tempat agen pengguna akan dialihkan setelah aplikasi keluar dari penyedia identitas. Pengalihan akan terjadi setelah SignedOutCallbackPath dipanggil.
SignInScheme	Mendapatkan atau mengatur skema autentikasi yang sesuai dengan middleware yang bertanggung jawab untuk mempertahankan identitas pengguna setelah autentikasi berhasil. Nilai ini biasanya sesuai dengan middleware cookie yang terdaftar di kelas Startup. Saat dihilangkan, DefaultSignInScheme digunakan sebagai nilai fallback. (Diperoleh dari RemoteAuthenticationOptions)
SignOutScheme	Skema Autentikasi yang akan digunakan dengan SignOut di SignOutPath. SignInScheme akan digunakan jika ini tidak diatur.
SkipUnrecognizedRequests	Menunjukkan apakah permintaan ke CallbackPath mungkin juga untuk komponen lain. Jika diaktifkan, handler akan meneruskan permintaan melalui yang tidak berisi respons autentikasi OpenIdConnect. Menonaktifkan ini dan mengatur CallbackPath ke titik akhir khusus dapat memberikan penanganan kesalahan yang lebih baik. Ini dinonaktifkan secara default.
StateDataFormat	Mendapatkan atau mengatur jenis yang digunakan untuk mengamankan data yang ditangani oleh handler.
StringDataFormat	Mendapatkan atau mengatur jenis yang digunakan untuk mengamankan string yang digunakan oleh handler.
TimeProvider	Digunakan untuk pengujian. (Diperoleh dari AuthenticationSchemeOptions)
TokenHandler	Mendapatkan atau mengatur TokenHandler yang digunakan untuk memvalidasi token identitas. Ini akan digunakan alih-alih SecurityTokenValidator jika UseSecurityTokenValidatorfalse.
TokenValidationParameters	Mendapatkan atau mengatur parameter yang digunakan untuk memvalidasi token identitas.
UsePkce	Mengaktifkan atau menonaktifkan penggunaan standar Proof Key for Code Exchange (PKCE). Ini hanya berlaku ketika ResponseType diatur ke Code. Lihat https://tools.ietf.org/html/rfc7636. Nilai defaultnya adalah true.
UseSecurityTokenValidator	Mendapatkan atau mengatur apakah akan menggunakan TokenHandler atau SecurityTokenValidator untuk memvalidasi token identitas.
UseTokenLifetime	Menunjukkan bahwa masa pakai sesi autentikasi (misalnya cookie) harus cocok dengan token autentikasi. Jika token tidak memberikan informasi seumur hidup, masa pakai sesi normal akan digunakan. Ini dinonaktifkan secara default.

Metode

Validate()	Periksa apakah opsi tersebut valid. Harus melemparkan pengecualian jika hal-hal tidak baik-baik saja.
Validate(String)	Memeriksa apakah opsi valid untuk skema tertentu (Diperoleh dari RemoteAuthenticationOptions)