UserFederatedIdentityCredentialParameters Kelas

Paket:

com.microsoft.aad.msal4j

Maven Artifact:

com.microsoft.azure:msal4j:1.26.0

• java.lang.Object
• • com.microsoft.aad.msal4j.UserFederatedIdentityCredentialParameters

Penerapan

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class UserFederatedIdentityCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

Objek yang berisi parameter untuk alur Kredensial Identitas Federasi Pengguna (user_fic). Ini digunakan untuk Leg 3 dari protokol identitas agen, di mana kredensial identitas federasi (diperoleh dari Leg 2) ditukar dengan token yang dilingkup pengguna.

Dapat digunakan sebagai parameter untuk acquireToken(UserFederatedIdentityCredentialParameters parameters)

Ringkasan Metode

Pemodifikasi dan Jenis	Metode dan Deskripsi
java.lang.String	assertion()
static UserFederatedIdentityCredentialParametersBuilder	builder(Set<String> scopes, String username, String assertion) Penyusun untuk UserFederatedIdentityCredentialParameters menggunakan UPN (Nama Prinsipal Pengguna).
static UserFederatedIdentityCredentialParametersBuilder	builder(Set<String> scopes, UUID userObjectId, String assertion) Penyusun untuk UserFederatedIdentityCredentialParameters menggunakan ID Objek pengguna.
ClaimsRequest	claims() Mendapatkan parameter permintaan klaim yang akan dikirim dengan permintaan autentikasi.
java.lang.String	clientClaims() Klaim yang berasal dari klien diatur melalui UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String).
java.lang.String	computeExtCacheKeyHash() Menghitung hash kunci cache yang diperluas dari semua komponen kunci cache, atau string kosong ketika tidak ada.
java.util.Map<java.lang.String,java.lang.String>	extraHttpHeaders() Mendapatkan header HTTP tambahan untuk disertakan dalam permintaan token.
java.util.Map<java.lang.String,java.lang.String>	extraQueryParameters() Tidak digunakan lagi Hanya ada untuk memenuhi IAcquireTokenParameters kontrak antarmuka. Tidak disarankan untuk digunakan — API ini dijadwalkan untuk dihapus di semua kelas parameter dan akan digantikan oleh mekanisme baru dalam rilis mendatang. Mendapatkan parameter kueri tambahan untuk disertakan dalam permintaan token.
boolean	forceRefresh()
java.util.Set<java.lang.String>	scopes() Mendapatkan serangkaian cakupan (izin) yang diminta untuk token akses.
java.lang.String	tenant() Mendapatkan pengidentifikasi penyewa untuk permintaan token.
java.lang.String	username()
java.util.UUID	userObjectId()

Metode diperoleh dari java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detail Metode

assertion

public String assertion()

Mengembalikan:

pernyataan kredensial identitas federasi (JWT)

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Penyusun untuk UserFederatedIdentityCredentialParameters menggunakan UPN (Nama Prinsipal Pengguna).

Parameter:

scopes - aplikasi cakupan meminta akses ke

username - UPN pengguna target (misalnya, "user@contoso.com")

assertion - pernyataan kredensial identitas federasi (JWT) yang diperoleh dari Leg 2

Mengembalikan:

builder yang dapat digunakan untuk membuat UserFederatedIdentityCredentialParameters

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

Penyusun untuk UserFederatedIdentityCredentialParameters menggunakan ID Objek pengguna.

Parameter:

scopes - aplikasi cakupan meminta akses ke

userObjectId - ID Objek (OID) pengguna target

assertion - pernyataan kredensial identitas federasi (JWT) yang diperoleh dari Leg 2

Mengembalikan:

builder yang dapat digunakan untuk membuat UserFederatedIdentityCredentialParameters

claims

public ClaimsRequest claims()

Mendapatkan parameter permintaan klaim yang akan dikirim dengan permintaan autentikasi.

Parameter permintaan klaim dapat digunakan untuk meminta klaim tertentu dikembalikan dalam token, untuk meminta autentikasi MFA, atau untuk mengontrol aspek penerbitan token lainnya.

clientClaims

public String clientClaims()

Klaim yang berasal dari klien diatur melalui UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String). Diteruskan ke titik akhir token sebagai parameter OAuth claims dan digunakan sebagai bagian dari kunci cache yang diperluas sehingga nilai klaim yang berbeda di-cache secara terpisah.

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Menghitung hash kunci cache yang diperluas dari semua komponen kunci cache, atau string kosong ketika tidak ada. Hasilnya dimemoisasi karena parameter tidak dapat diubah setelah konstruksi.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Mendapatkan header HTTP tambahan untuk disertakan dalam permintaan token.

Header ini akan ditambahkan ke permintaan HTTP yang dikirim ke titik akhir token. Ini dapat berguna untuk skenario yang memerlukan header kustom untuk proksi atau untuk tujuan diagnostik.

extraQueryParameters

public Map<String,String> extraQueryParameters()

Tidak digunakan lagi

Hanya ada untuk memenuhi IAcquireTokenParameters kontrak antarmuka. Tidak disarankan untuk digunakan — API ini dijadwalkan untuk dihapus di semua kelas parameter dan akan digantikan oleh mekanisme baru dalam rilis mendatang.

Mendapatkan parameter kueri tambahan untuk disertakan dalam permintaan token.

Parameter ini akan ditambahkan ke string kueri dalam permintaan ke titik akhir otorisasi dan token. Ini dapat berguna untuk skenario yang memerlukan parameter kustom yang tidak didukung secara eksplisit di pustaka.

forceRefresh

public boolean forceRefresh()

Mengembalikan:

apakah akan melewati cache token dan memaksa permintaan token baru

scopes

public Set<String> scopes()

Mendapatkan serangkaian cakupan (izin) yang diminta untuk token akses.

Cakupan mewakili izin tempat aplikasi meminta akses.

tenant

public String tenant()

Mendapatkan pengidentifikasi penyewa untuk permintaan token.

Ketika ditentukan, nilai ini mengambil alih penyewa yang ditentukan dalam URL otoritas aplikasi. Ini bisa berupa ID penyewa (GUID), nama domain, atau salah satu nilai khusus seperti "umum" atau "organisasi".

username

public String username()

Mengembalikan:

UPN pengguna target, atau null jika pengguna diidentifikasi oleh ID Objek

userObjectId

public UUID userObjectId()

Mengembalikan:

ID Objek pengguna target, atau null jika pengguna diidentifikasi oleh UPN