UserFederatedIdentityCredentialParameters 类
- java.
lang. Object - com.
microsoft. aad. msal4j. UserFederatedIdentityCredentialParameters
- com.
实现
public class UserFederatedIdentityCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters
包含用户联合标识凭据(user_fic)流的参数的对象。 这用于代理标识协议的 Leg 3,其中联合标识凭据(从 Leg 2 获取)将交换为用户范围的令牌。
可用作参数 acquireToken(UserFederatedIdentityCredentialParameters parameters)
方法摘要
| 修饰符和类型 | 方法和描述 |
|---|---|
| java.lang.String | assertion() |
|
static
User |
builder(Set<String> scopes, String username, String assertion)
UserFederatedIdentityCredentialParameters用于使用 UPN(用户主体名称)的生成器。 |
|
static
User |
builder(Set<String> scopes, UUID userObjectId, String assertion)
UserFederatedIdentityCredentialParameters用于使用用户对象 ID 的生成器。 |
|
Claims |
claims()
获取将使用身份验证请求发送的声明请求参数。 |
| java.lang.String |
clientClaims()
通过 UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String). 设置的客户端发起的声明。 |
| java.lang.String |
computeExtCacheKeyHash()
从所有缓存密钥组件或空字符串计算扩展缓存密钥哈希(如果没有)。 |
| java.util.Map<java.lang.String,java.lang.String> |
extraHttpHeaders()
获取要包含在令牌请求中的其他 HTTP 标头。 |
| java.util.Map<java.lang.String,java.lang.String> |
extraQueryParameters()
已放弃
仅存在以满足 IAcquireTokenParameters 接口协定。 不建议使用 — 此 API 计划在所有参数类中删除,并将在将来的版本中替换为新机制。
获取要包含在令牌请求中的其他查询参数。 |
| boolean | forceRefresh() |
| java.util.Set<java.lang.String> |
scopes()
获取为访问令牌请求的范围(权限)集。 |
| java.lang.String |
tenant()
获取令牌请求的租户标识符。 |
| java.lang.String | username() |
| java.util.UUID | userObjectId() |
方法继承自 java.lang.Object
方法详细信息
assertion
public String assertion()
返回:
builder
public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)
UserFederatedIdentityCredentialParameters用于使用 UPN(用户主体名称)的生成器。
参数:
返回:
builder
public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)
UserFederatedIdentityCredentialParameters用于使用用户对象 ID 的生成器。
参数:
返回:
claims
public ClaimsRequest claims()
获取将使用身份验证请求发送的声明请求参数。
声明请求参数可用于请求令牌中返回的特定声明、请求 MFA 身份验证或控制令牌颁发的其他方面。
clientClaims
public String clientClaims()
通过 UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String). 设置的客户端发起的声明。 作为 OAuth claims 参数转发到令牌终结点,并用作扩展缓存密钥的一部分,以便单独缓存不同的声明值。
computeExtCacheKeyHash
public String computeExtCacheKeyHash()
从所有缓存密钥组件或空字符串计算扩展缓存密钥哈希(如果没有)。 由于参数在构造后不可变,因此结果被备忘录化。
extraHttpHeaders
public Map<String,String> extraHttpHeaders()
获取要包含在令牌请求中的其他 HTTP 标头。
这些标头将添加到发送到令牌终结点的 HTTP 请求中。 这对于需要自定义标头的代理或诊断目的的方案非常有用。
extraQueryParameters
public Map<String,String> extraQueryParameters()
已放弃
获取要包含在令牌请求中的其他查询参数。
这些参数将添加到对授权和令牌终结点的请求中的查询字符串。 这对于需要库中未显式支持的自定义参数的方案非常有用。
forceRefresh
public boolean forceRefresh()
返回:
scopes
public Set<String> scopes()
获取为访问令牌请求的范围(权限)集。
范围表示应用程序请求访问的权限。
tenant
public String tenant()
获取令牌请求的租户标识符。
指定后,此值将替代应用程序颁发机构 URL 中指定的租户。 它可以是租户 ID(GUID)、域名或特殊值之一,例如“common”或“organizations”。
username
public String username()
返回:
userObjectId
public UUID userObjectId()
返回: