JwtBearerOptions Kelas

Definisi

Ruang nama:

Microsoft.AspNetCore.Authentication.JwtBearer

Rakitan:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

Paket:

Microsoft.AspNetCore.Authentication.JwtBearer v8.0.0

Sumber:

JwtBearerOptions.cs

Kelas Opsi menyediakan informasi yang diperlukan untuk mengontrol perilaku handler Autentikasi Pembawa

public ref class JwtBearerOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions

public class JwtBearerOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type JwtBearerOptions = class
    inherit AuthenticationSchemeOptions

Public Class JwtBearerOptions
Inherits AuthenticationSchemeOptions

Warisan

Object

AuthenticationSchemeOptions

JwtBearerOptions

Konstruktor

JwtBearerOptions()

Menginisialisasi instans baru .JwtBearerOptions

Properti

Audience	Mendapatkan atau menetapkan satu nilai audiens yang valid untuk setiap token OpenIdConnect yang diterima. Nilai ini diteruskan ke TokenValidationParameters.ValidAudience jika properti tersebut kosong.
Authority	Mendapatkan atau mengatur Otoritas yang akan digunakan saat melakukan panggilan OpenIdConnect.
AutomaticRefreshInterval	Mendapatkan atau mengatur seberapa sering refresh metadata otomatis harus terjadi.
Backchannel	Backchannel digunakan untuk mengambil metadata.
BackchannelHttpHandler	HttpMessageHandler digunakan untuk mengambil metadata. Ini tidak dapat diatur pada saat yang sama dengan BackchannelCertificateValidator kecuali nilainya adalah WebRequestHandler.
BackchannelTimeout	Mendapatkan atau mengatur batas waktu saat menggunakan backchannel untuk melakukan panggilan http.
Challenge	Mendapatkan atau menetapkan tantangan untuk dimasukkan ke header "WWW-Authenticate".
ClaimsIssuer	Mendapatkan atau menetapkan penerbit yang harus digunakan untuk klaim apa pun yang dibuat (Diperoleh dari AuthenticationSchemeOptions)
Configuration	Konfigurasi yang disediakan langsung oleh pengembang. Jika disediakan, maka metadataAddress dan properti 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 satu akan dibuat menggunakan properti MetadataAddress dan Backchannel.
Events	Objek yang disediakan oleh aplikasi untuk memproses peristiwa yang diangkat oleh penangan autentikasi pembawa. Aplikasi dapat mengimplementasikan antarmuka sepenuhnya, atau dapat membuat instans JwtBearerEvents dan menetapkan delegasi hanya untuk peristiwa yang ingin diproses.
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 tempat skema ini harus 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 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 bukan 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 bukan 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)
IncludeErrorDetails	Menentukan apakah kesalahan validasi token harus dikembalikan ke pemanggil. Diaktifkan secara default, opsi ini dapat dinonaktifkan untuk mencegah handler JWT mengembalikan kesalahan dan error_description di header WWW-Authenticate.
MapInboundClaims	Mendapatkan atau mengatur properti pada instans MapInboundClaimsJwtSecurityTokenHandler default di SecurityTokenValidators, atau JsonWebTokenHandler di TokenHandlers, yang digunakan saat menentukan apakah akan memetakan jenis klaim yang diekstrak atau tidak saat memvalidasi JwtSecurityToken atau JsonWebToken. 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.
MetadataAddress	Mendapatkan atau mengatur titik akhir penemuan untuk mendapatkan metadata
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. Hal ini diaktifkan secara default.
RequireHttpsMetadata	Mendapatkan atau mengatur apakah HTTPS diperlukan untuk alamat metadata atau otoritas. Secara default adalah benar. Ini harus dinonaktifkan hanya di lingkungan pengembangan.
SaveToken	Menentukan apakah token pembawa harus disimpan di AuthenticationProperties setelah otorisasi berhasil.
SecurityTokenValidators	Kedaluwarsa. Mendapatkan daftar yang diurutkan dari yang ISecurityTokenValidator digunakan untuk memvalidasi token akses.
TimeProvider	Digunakan untuk pengujian. (Diperoleh dari AuthenticationSchemeOptions)
TokenHandlers	Mendapatkan daftar yang diurutkan dari yang TokenHandler digunakan untuk memvalidasi token akses.
TokenValidationParameters	Mendapatkan atau mengatur parameter yang digunakan untuk memvalidasi token identitas.
UseSecurityTokenValidators	Mendapatkan atau mengatur apakah TokenHandlers atau SecurityTokenValidators akan digunakan untuk memvalidasi token masuk.

Metode

Validate()	Periksa apakah opsinya valid. Harus melemparkan pengecualian jika semuanya tidak baik-baik saja. (Diperoleh dari AuthenticationSchemeOptions)
Validate(String)	Memeriksa apakah opsi valid untuk skema tertentu (Diperoleh dari AuthenticationSchemeOptions)