AcquireTokenForClientParameterBuilder 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.
Builder untuk AcquireTokenForClient (digunakan dalam alur kredensial klien, dalam aplikasi daemon). Lihat https://aka.ms/msal-net-client-credentials
public sealed class AcquireTokenForClientParameterBuilder : Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder>type AcquireTokenForClientParameterBuilder = class
inherit AbstractConfidentialClientAcquireTokenParameterBuilder<AcquireTokenForClientParameterBuilder>Public NotInheritable Class AcquireTokenForClientParameterBuilder
Inherits AbstractConfidentialClientAcquireTokenParameterBuilder(Of AcquireTokenForClientParameterBuilder)- Warisan
Metode
| Nama | Deskripsi |
|---|---|
| ExecuteAsync() |
Menjalankan permintaan Token secara asinkron. (Diperoleh dari BaseAbstractAcquireTokenParameterBuilder<T>) |
| ExecuteAsync(CancellationToken) |
Menjalankan permintaan Token secara asinkron, dengan kemungkinan membatalkan metode asinkron. (Diperoleh dari AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| Validate() |
Memvalidasi parameter operasi AcquireToken. (Diperoleh dari AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithAdfsAuthority(String, Boolean) |
Menambahkan Otoritas yang diketahui sesuai dengan server ADFS. Lihat https://aka.ms/msal-net-adfs. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAttributes(String) |
Menentukan atribut identitas untuk disertakan dalam permintaan token. Nilai atribut akan dikembalikan sebagai klaim dalam token yang disebut "xms_attr" dalam klaim token akses. Ini biasanya digunakan dengan skenario FMI (Federated Managed Identity). Contoh atribut json: "{"sg1":"0000-00000-0001","sg2":["0000-00000-0002","0000-00000-00003","0000-00000-0004"]}" |
| WithAuthority(AadAuthorityAudience, Boolean) |
Kedaluwarsa.
Penting: Gunakan WithTenantId atau WithTenantIdFromAuthority sebagai gantinya, atau WithB2CAuthority untuk otoritas B2C. Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna yang menentukan audiens masuk (cloud menjadi cloud publik Azure). Lihat https://aka.ms/msal-net-application-configuration. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean) |
Kedaluwarsa.
Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna yang menentukan instans cloud dan audiens masuk. Lihat https://aka.ms/msal-net-application-configuration. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, Guid, Boolean) |
Kedaluwarsa.
Penting: Gunakan WithTenantId atau WithTenantIdFromAuthority sebagai gantinya, atau WithB2CAuthority untuk otoritas B2C. Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang dijelaskan oleh instans cloud dan ID penyewanya. Lihat https://aka.ms/msal-net-application-configuration. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(AzureCloudInstance, String, Boolean) |
Kedaluwarsa.
Penting: Gunakan WithTenantId atau WithTenantIdFromAuthority sebagai gantinya, atau WithB2CAuthority untuk otoritas B2C. Menambahkan otoritas AD Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang dijelaskan oleh instans cloud dan nama domain atau ID penyewanya. Lihat https://aka.ms/msal-net-application-configuration. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Boolean) |
Kedaluwarsa.
Penting: Gunakan WithTenantId atau WithTenantIdFromAuthority sebagai gantinya, atau WithB2CAuthority untuk otoritas B2C. Otoritas khusus yang diminta token. Meneruskan nilai yang berbeda dari yang dikonfigurasi di konstruktor aplikasi mempersempit pilihan ke penyewa tertentu. Ini tidak mengubah nilai yang dikonfigurasi dalam aplikasi. Ini khusus untuk aplikasi yang mengelola beberapa akun (seperti klien email dengan beberapa kotak surat). Lihat https://aka.ms/msal-net-application-configuration. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, Guid, Boolean) |
Kedaluwarsa.
Penting: Gunakan WithTenantId atau WithTenantIdFromAuthority sebagai gantinya, atau WithB2CAuthority untuk otoritas B2C. Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang ditentukan oleh ID penyewanya. Lihat https://aka.ms/msal-net-application-configuration. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAuthority(String, String, Boolean) |
Kedaluwarsa.
Penting: Gunakan WithTenantId atau WithTenantIdFromAuthority sebagai gantinya, atau WithB2CAuthority untuk otoritas B2C. Menambahkan otoritas ad Azure yang diketahui ke aplikasi untuk memasukkan pengguna dari satu organisasi (aplikasi penyewa tunggal) yang dijelaskan oleh nama domainnya. Lihat https://aka.ms/msal-net-application-configuration. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithAzureRegion(Boolean) |
Kedaluwarsa.
Silakan gunakan WithAzureRegion pada objek ConfidentialClientApplicationBuilder |
| WithB2CAuthority(String) |
Menambahkan otoritas yang diketahui sesuai dengan kebijakan AD B2C Azure. Lihat https://aka.ms/msal-net-b2c-specificities (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithClaims(String) |
Mengatur klaim dalam kueri. Gunakan saat admin AAD telah mengaktifkan akses bersyarah. Memperoleh token secara normal akan menghasilkan dengan MsalUiRequiredExceptionClaims set properti. Coba lagi akuisisi token, dan gunakan nilai ini dalam WithClaims(String) metode . Lihat https://aka.ms/msal-exceptions untuk detail serta https://aka.ms/msal-net-claim-challenge. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithCorrelationId(Guid) |
Mengatur id korelasi yang akan digunakan dalam permintaan autentikasi. Digunakan untuk melacak permintaan di log SDK dan layanan Penyedia Identitas. Jika tidak diatur, yang acak akan dihasilkan. (Diperoleh dari BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(Dictionary<String,String>) |
Kedaluwarsa.
Mengatur Parameter Kueri Ekstra untuk string kueri dalam permintaan autentikasi HTTP. (Diperoleh dari BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>) |
Mengatur Parameter Kueri Ekstra untuk string kueri dalam permintaan autentikasi HTTP dengan kontrol atas parameter mana yang disertakan dalam kunci cache (Diperoleh dari BaseAbstractAcquireTokenParameterBuilder<T>) |
| WithExtraQueryParameters(String) |
Kedaluwarsa.
Mengatur Parameter Kueri Ekstra untuk string kueri dalam permintaan autentikasi HTTP. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithFmiPath(String) |
Menambahkan parameter fmi_path ke permintaan. Ini memodifikasi subjek token. |
| WithForceRefresh(Boolean) |
Menentukan apakah aplikasi klien harus mengabaikan token akses saat membaca cache token. Token baru masih akan ditulis ke cache token aplikasi. Secara default token diambil dari cache token aplikasi (forceRefresh=false) |
| WithMtlsProofOfPossession() |
Menentukan bahwa sertifikat yang disediakan akan digunakan untuk token PoP dengan autentikasi mTLS (Mutual TLS). Untuk informasi selengkapnya, lihat dokumentasi Bukti Kepemilikan. |
| WithPreferredAzureRegion(Boolean, String, Boolean) |
Kedaluwarsa.
Silakan gunakan WithAzureRegion pada objek ConfidentialClientApplicationBuilder |
| WithProofOfPossession(PoPAuthenticationConfiguration) |
Kedaluwarsa.
Memodifikasi permintaan akuisisi token sehingga token yang diperoleh adalah token Bukti Kepemilikan (PoP), bukan token Pembawa. Token PoP mirip dengan token Pembawa, tetapi terikat pada permintaan HTTP dan ke kunci kriptografi, yang dapat dikelola MSAL pada Windows. Lihat https://aka.ms/msal-net-pop (Diperoleh dari AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithScopes(IEnumerable<String>) |
Menentukan cakupan mana yang akan diminta. Metode ini digunakan ketika aplikasi Anda perlu menentukan cakupan yang diperlukan untuk memanggil API yang dilindungi. <Lihat>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent</lihat> untuk mempelajari selengkapnya tentang cakupan, izin, dan persetujuan, dan <lihat>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes</lihat> untuk mempelajari cara membuat cakupan untuk aplikasi warisan yang digunakan untuk mengekspos izin OAuth2. (Diperoleh dari AbstractAcquireTokenParameterBuilder<T>) |
| WithSendX5C(Boolean) |
Hanya berlaku untuk aplikasi pihak pertama, metode ini juga memungkinkan untuk menentukan apakah klaim x5c harus dikirim ke Azure AD. Mengirim x5c memungkinkan pengembang aplikasi untuk mencapai roll-over sertifikat yang mudah di Azure AD: metode ini akan mengirim rantai sertifikat ke Azure AD bersama dengan permintaan token, sehingga Azure AD dapat menggunakannya untuk memvalidasi nama subjek berdasarkan kebijakan penerbit tepercaya. Ini menyimpan admin aplikasi dari kebutuhan untuk mengelola rollover sertifikat secara eksplisit (baik melalui portal atau operasi PowerShell/CLI). Untuk detailnya lihat https://aka.ms/msal-net-sni |
| WithSignedHttpRequestProofOfPossession(PoPAuthenticationConfiguration) |
Memodifikasi permintaan untuk memperoleh token Proof-of-Possession (PoP) Permintaan HTTP (SHR) yang Ditandatangani, bukan Pembawa. Token PoP SHR terikat pada permintaan HTTP dan ke kunci kriptografi, yang dikelola MSAL pada Windows. Token PoP SHR berbeda dari token mTLS PoP, yang digunakan untuk autentikasi TLS Bersama (mTLS). Lihat https://aka.ms/mtls-pop untuk detailnya. (Diperoleh dari AbstractConfidentialClientAcquireTokenParameterBuilder<T>) |
| WithTenantId(String) |
Mengambil alih ID penyewa yang ditentukan dalam otoritas di tingkat aplikasi. Operasi ini mempertahankan host otoritas (lingkungan). Jika otoritas tidak ditentukan pada tingkat aplikasi, default yang digunakan adalah |
| WithTenantIdFromAuthority(Uri) |
Mengekstrak ID penyewa dari URI otoritas yang disediakan dan mengambil alih ID penyewa yang ditentukan dalam otoritas di tingkat aplikasi. Operasi ini mempertahankan host otoritas (lingkungan) yang disediakan untuk pembuat aplikasi.
Jika otoritas tidak diberikan kepada pembuat aplikasi, metode ini akan menggantikan ID penyewa di otoritas default - |
Metode Ekstensi
| Nama | Deskripsi |
|---|---|
| OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>) |
Campur tangan dalam alur permintaan, dengan menjalankan delegasi yang disediakan pengguna sebelum MSAL membuat permintaan token. Delegasi dapat mengubah payload permintaan dengan menambahkan atau menghapus parameter isi dan header. OnBeforeTokenRequestData |
| WithAccessTokenSha256ToRefresh(AcquireTokenForClientParameterBuilder, String) |
Mengonfigurasi SDK untuk tidak mengambil token dari cache jika cocok dengan hash SHA256 dari token yang dikonfigurasi. Mirip dengan WithForceRefresh(bool) API, tetapi alih-alih melewati cache untuk semua token, bypass cache hanya terjadi untuk 1 token |
| WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
Menentukan parameter tambahan yang diperoleh dari respons autentikasi untuk di-cache dengan token akses yang biasanya tidak disertakan dalam objek cache. nilai-nilai ini dapat dibaca dari AdditionalResponseParameters parameter . |
| WithAttributeTokens<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, IEnumerable<String>) |
|
| WithAuthenticationExtension<T>(AbstractAcquireTokenParameterBuilder<T>, MsalAuthenticationExtension) |
Memungkinkan aplikasi klien untuk menyediakan operasi autentikasi kustom yang akan digunakan dalam permintaan akuisisi token. |
| WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String) |
Menambahkan pasangan kunci-nilai ke kunci cache token tanpa mengirimkannya sebagai parameter kueri.
Gunakan ini untuk mempartisi token yang di-cache (misalnya, mengisolasi sesi berumur pendek dari sesi reguler untuk pengguna yang sama). Keduanya |
| WithClaimsFromClient<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, String) |
Menentukan klaim yang berasal dari klien untuk disertakan dalam permintaan token. Tidak seperti WithClaims(String) (untuk tantangan klaim yang dikeluarkan server), token yang diperoleh dengan klaim klien di-cache dan entri cache dikunci pada nilai klaim. Nilai klaim yang berbeda menghasilkan entri cache terpisah. Gunakan nilai yang stabil dan tidak dinamis untuk menghindari pertumbuhan cache yang tidak terbatas. |
| WithExtraBodyParameters(AcquireTokenForClientParameterBuilder, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Tambahkan parameter isi tambahan ke permintaan token. Parameter ini ditambahkan ke kunci cache untuk mengaitkan parameter ini dengan token yang diperoleh. |
| WithExtraBodyParameters<T>(AbstractConfidentialClientAcquireTokenParameterBuilder<T>, Dictionary<String,Func<CancellationToken,Task<String>>>) |
Tambahkan parameter isi tambahan ke permintaan token. Parameter ini ditambahkan ke kunci cache untuk mengaitkan parameter ini dengan token yang diperoleh. Bekerja untuk alur klien rahasia (AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode). |
| WithExtraClientAssertionClaims<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Menentukan klaim tambahan yang akan disertakan dalam pernyataan klien. Klaim ini akan digabungkan dengan klaim default ketika pernyataan klien dihasilkan. Ini memungkinkan API tingkat yang lebih tinggi seperti Microsoft. Identity.Web menyediakan klaim tambahan untuk pernyataan klien. Penting: token dikaitkan dengan klaim pernyataan klien tambahan, yang berdampak pada pencarian cache. Ini adalah API ekstensibilitas dan tidak boleh digunakan oleh aplikasi secara langsung. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Kedaluwarsa.
Menambahkan Header Http tambahan ke permintaan token. |
| WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>) |
Menambahkan header HTTP tambahan ke permintaan token. |
| WithFmiPathForClientAssertion<T>(AbstractAcquireTokenParameterBuilder<T>, String) |
Menentukan jalur FMI yang akan digunakan untuk pernyataan klien. Hal ini memungkinkan API tingkat yang lebih tinggi seperti Id.Web menyediakan kredensial yang sensitif terhadap FMI. Penting: token dikaitkan dengan jalur FMI kredensial, yang berdampak pada pencarian cache Ini adalah API ekstensibilitas dan tidak boleh digunakan oleh aplikasi. |
| WithProofOfPosessionKeyId(AcquireTokenForClientParameterBuilder, String, String) |
Mengikat token ke kunci di cache. Kunci cache L2 berisi id kunci. Tidak ada operasi kriptografi yang dilakukan pada token. |
| WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, String, String) |
Mengikat token ke kunci di cache. Tidak ada operasi kriptografi yang dilakukan pada token. |