UserFederatedIdentityCredentialParameters Klas

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

Implementeringen

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Object met parameters voor de stroom user Federated Identity Credential (user_fic). Dit wordt gebruikt voor Leg 3 van het identiteitsprotocol van de agent, waarbij een federatieve identiteitsreferentie (verkregen uit Leg 2) wordt uitgewisseld voor een token met gebruikersbereik.

Kan worden gebruikt als parameter voor acquireToken(UserFederatedIdentityCredentialParameters parameters)

Methodesamenvatting

Modifier en type Methode en beschrijving
java.lang.String assertion()
static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Opbouwfunctie voor UserFederatedIdentityCredentialParameters het gebruik van een UPN (User Principal Name).

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

Opbouwfunctie voor UserFederatedIdentityCredentialParameters het gebruik van een gebruikersobject-id.

ClaimsRequest claims()

Hiermee haalt u de claimaanvraagparameter op die wordt verzonden met de verificatieaanvraag.

java.lang.String clientClaims()

Claims die afkomstig zijn van de client via UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String).

java.lang.String computeExtCacheKeyHash()

Berekent de uitgebreide cachesleutel-hash van alle onderdelen van de cachesleutel of een lege tekenreeks wanneer er geen zijn.

java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Hiermee worden extra HTTP-headers opgehaald die moeten worden opgenomen in de tokenaanvraag.

java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Afgeschaft

Alleen aanwezig om te voldoen aan het IAcquireTokenParameters interfacecontract. Niet aanbevolen voor gebruik: deze API is gepland voor verwijdering in alle parameterklassen en wordt vervangen door een nieuw mechanisme in een toekomstige release.

Hiermee worden extra queryparameters opgehaald die moeten worden opgenomen in de tokenaanvraag.

boolean forceRefresh()
java.util.Set<java.lang.String> scopes()

Hiermee haalt u de set bereiken (machtigingen) op die zijn aangevraagd voor het toegangstoken.

java.lang.String tenant()

Hiermee haalt u de tenant-id voor de tokenaanvraag op.

java.lang.String username()
java.util.UUID userObjectId()

Methoden overgenomen van 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

Methodedetails

assertion

public String assertion()

Retouren:

de federatieve identiteitsreferentie-assertie (JWT)

builder

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

Opbouwfunctie voor UserFederatedIdentityCredentialParameters het gebruik van een UPN (User Principal Name).

Parameters:

scopes - scopes-toepassing vraagt toegang tot
username - de UPN van de doelgebruiker (bijvoorbeeld "user@contoso.com")
assertion - de federatieve identiteitsreferentie-assertie (JWT) verkregen uit Leg 2

Retouren:

builder die kan worden gebruikt om UserFederatedIdentityCredentialParameters samen te stellen

builder

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

Opbouwfunctie voor UserFederatedIdentityCredentialParameters het gebruik van een gebruikersobject-id.

Parameters:

scopes - scopes-toepassing vraagt toegang tot
userObjectId - de object-id (OID) van de doelgebruiker
assertion - de federatieve identiteitsreferentie-assertie (JWT) verkregen uit Leg 2

Retouren:

builder die kan worden gebruikt om UserFederatedIdentityCredentialParameters samen te stellen

claims

public ClaimsRequest claims()

Hiermee haalt u de claimaanvraagparameter op die wordt verzonden met de verificatieaanvraag.

De claimaanvraagparameter kan worden gebruikt om specifieke claims aan te vragen die moeten worden geretourneerd in het token, om MFA-verificatie aan te vragen of om andere aspecten van tokenuitgifte te beheren.

clientClaims

public String clientClaims()

Claims die afkomstig zijn van de client via UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String). Doorgestuurd naar het tokeneindpunt als de OAuth-parameter claims en wordt gebruikt als onderdeel van de uitgebreide cachesleutel, zodat afzonderlijke claimwaarden afzonderlijk in de cache worden opgeslagen.

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Berekent de uitgebreide cachesleutel-hash van alle onderdelen van de cachesleutel of een lege tekenreeks wanneer er geen zijn. Het resultaat wordt onthouden omdat de parameters onveranderbaar zijn na de constructie.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Hiermee worden extra HTTP-headers opgehaald die moeten worden opgenomen in de tokenaanvraag.

Deze headers worden toegevoegd aan de HTTP-aanvragen die naar het tokeneindpunt worden verzonden. Dit kan handig zijn voor scenario's waarvoor aangepaste headers zijn vereist voor proxy's of voor diagnostische doeleinden.

extraQueryParameters


public Map<String,String> extraQueryParameters()

Afgeschaft

Alleen aanwezig om te voldoen aan het IAcquireTokenParameters interfacecontract. Niet aanbevolen voor gebruik: deze API is gepland voor verwijdering in alle parameterklassen en wordt vervangen door een nieuw mechanisme in een toekomstige release.

Hiermee worden extra queryparameters opgehaald die moeten worden opgenomen in de tokenaanvraag.

Deze parameters worden toegevoegd aan de querytekenreeks in aanvragen voor de autorisatie- en tokeneindpunten. Dit kan handig zijn voor scenario's waarvoor aangepaste parameters zijn vereist die niet expliciet worden ondersteund in de bibliotheek.

forceRefresh

public boolean forceRefresh()

Retouren:

of de tokencache moet worden overgeslagen en een nieuwe tokenaanvraag moet worden afgedwongen

scopes

public Set<String> scopes()

Hiermee haalt u de set bereiken (machtigingen) op die zijn aangevraagd voor het toegangstoken.

Bereiken vertegenwoordigen de machtigingen waartoe de toepassing toegang aanvraagt.

tenant

public String tenant()

Hiermee haalt u de tenant-id voor de tokenaanvraag op.

Wanneer deze waarde is opgegeven, wordt de tenant die is opgegeven in de instantie-URL van de toepassing overschreven. Dit kan een tenant-id (GUID), domeinnaam of een van de speciale waarden zijn, zoals 'common' of 'organizations'.

username

public String username()

Retouren:

de UPN van de doelgebruiker of null als de gebruiker is geïdentificeerd met object-id

userObjectId

public UUID userObjectId()

Retouren:

de object-id van de doelgebruiker of null als de gebruiker is geïdentificeerd door UPN

Van toepassing op