OpenIdConnectOptions Kelas
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Opsi konfigurasi untuk OpenIdConnectMiddleware
public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions
public class OpenIdConnectOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions
type OpenIdConnectOptions = class
inherit RemoteAuthenticationOptions
Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions
- Warisan
Konstruktor
OpenIdConnectOptions() |
Menginisialisasi baru OpenIdConnectOptions |
OpenIdConnectOptions(String) |
Menginisialisasi baru OpenIdConnectOptions |
Properti
AuthenticationMethod |
Mendapatkan atau mengatur metode yang digunakan untuk mengalihkan agen pengguna ke IdP. |
AuthenticationScheme |
AuthenticationScheme dalam opsi sesuai dengan nama logis untuk skema autentikasi tertentu. Nilai yang berbeda dapat ditetapkan untuk menggunakan jenis middleware autentikasi yang sama lebih dari sekali dalam alur. (Diperoleh dari AuthenticationOptions) |
Authority |
Mendapatkan atau mengatur Otoritas yang akan digunakan saat melakukan panggilan OpenIdConnect. |
AutomaticAuthenticate |
Jika benar, middleware autentikasi mengubah pengguna permintaan yang masuk. Jika false middleware autentikasi hanya akan memberikan identitas ketika secara eksplisit ditunjukkan oleh AuthenticationScheme. (Diperoleh dari AuthenticationOptions) |
AutomaticChallenge |
Jika benar, middleware autentikasi harus menangani tantangan otomatis. Jika false middleware autentikasi hanya akan mengubah respons ketika secara eksplisit ditunjukkan oleh AuthenticationScheme. (Diperoleh dari AuthenticationOptions) |
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) |
ClaimsIssuer |
Mendapatkan atau mengatur penerbit yang harus digunakan untuk klaim apa pun yang dibuat (Diperoleh dari AuthenticationOptions) |
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, penembolokan, dan menyegarkan konfigurasi dari metadata. Jika tidak disediakan, maka akan dibuat menggunakan properti MetadataAddress dan Backchannel. |
Description |
Informasi tambahan tentang jenis autentikasi yang tersedia untuk aplikasi. (Diperoleh dari AuthenticationOptions) |
DisplayName |
Mendapatkan atau mengatur teks yang dapat ditampilkan pengguna pada antarmuka pengguna masuk. (Diperoleh dari RemoteAuthenticationOptions) |
Events |
Mendapatkan atau mengatur IOpenIdConnectEvents untuk memberi tahu saat memproses pesan OpenIdConnect. |
GetClaimsFromUserInfoEndpoint |
Boolean untuk mengatur apakah middleware 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'. |
MetadataAddress |
Mendapatkan atau mengatur titik akhir penemuan untuk mendapatkan metadata |
PostLogoutRedirectUri |
Uri tempat agen pengguna akan dikembalikan setelah aplikasi keluar dari IdP. Pengalihan akan terjadi setelah SignedOutCallbackPath dipanggil. |
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 |
RefreshOnIssuerKeyNotFound |
Mendapatkan atau mengatur apakah refresh metadata harus dicoba setelah SecurityTokenSignatureKeyNotFoundException. Ini memungkinkan pemulihan otomatis jika terjadi rollover kunci tanda tangan. Hal ini diaktifkan secara default. |
RemoteAuthenticationTimeout |
Mendapatkan atau menetapkan batas waktu untuk menyelesaikan alur autentikasi (15 menit secara default). (Diperoleh dari RemoteAuthenticationOptions) |
RemoteSignOutPath |
Permintaan yang diterima pada jalur ini akan menyebabkan middleware memanggil SignOut menggunakan SignInScheme. |
RequireHttpsMetadata |
Mendapatkan atau mengatur apakah HTTPS diperlukan untuk alamat metadata atau otoritas. Secara default adalah benar. 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'. |
SaveTokens |
Menentukan apakah token akses dan refresh harus disimpan setelah AuthenticationProperties otorisasi berhasil.
Properti ini diatur ke |
Scope |
Mendapatkan daftar izin untuk diminta. |
SecurityTokenValidator |
Mendapatkan atau mengatur yang ISecurityTokenValidator digunakan untuk memvalidasi token identitas. |
SignedOutCallbackPath |
Jalur permintaan dalam jalur dasar aplikasi tempat agen pengguna akan dikembalikan setelah keluar dari Penyedia Identitas. |
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, SignInScheme 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, middleware 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. Opsi ini dinonaktifkan secara default. |
StateDataFormat |
Mendapatkan atau mengatur jenis yang digunakan untuk mengamankan data yang ditangani oleh middleware. |
StringDataFormat |
Mendapatkan atau mengatur jenis yang digunakan untuk mengamankan string yang digunakan oleh middleware. |
SystemClock |
Hanya untuk tujuan pengujian. |
SystemClock |
Hanya untuk tujuan pengujian. (Diperoleh dari AuthenticationOptions) |
TokenValidationParameters |
Mendapatkan atau mengatur parameter yang digunakan 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. Opsi ini dinonaktifkan secara default. |