ClaimsRequest 类

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

public class ClaimsRequest

表示声明请求参数作为对象

构造函数摘要

构造函数 说明
ClaimsRequest()

方法摘要

修饰符和类型 方法和描述
static ClaimsRequest formatAsClaimsRequest(String claims)

从 JSON 格式的字符串创建声明请求的实例,该字符串遵循 OIDC 声明请求参数的规范

java.lang.String formatAsJSONString()

将声明请求对象转换为 JSON 格式的字符串,该字符串遵循 OIDC 声明请求参数的规范

java.util.List<RequestedClaim> getIdTokenRequestedClaims()
protected void requestClaimInAccessToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

将声明插入要添加到 OIDC 声明请求的“access_token”部分的声明列表中

void requestClaimInIdToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

将声明插入要添加到 OIDC 声明请求的“id_token”部分中的声明列表中

protected void requestClaimInUserInfo(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

将声明插入要添加到 OIDC 声明请求的“userinfo”部分的声明列表中

void setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)

方法继承自 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

构造函数详细信息

ClaimsRequest

public ClaimsRequest()

方法详细信息

formatAsClaimsRequest

public static ClaimsRequest formatAsClaimsRequest(String claims)

从 JSON 格式的字符串创建 ClaimsRequest 的实例,该字符串遵循 OIDC 声明请求参数的规范

参数:

claims - 以下 JSON 格式的字符串

返回:

ClaimsRequest 实例

formatAsJSONString

public String formatAsJSONString()

将 ClaimsRequest 对象转换为 JSON 格式的字符串,该字符串遵循 OIDC 声明请求参数的规范

返回:

以下 JSON 格式的字符串

getIdTokenRequestedClaims

public List<RequestedClaim> getIdTokenRequestedClaims()

requestClaimInAccessToken

protected void requestClaimInAccessToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

将声明插入要添加到 OIDC 声明请求的“access_token”部分的声明列表中

参数:

claim - 要请求的声明的名称
requestedClaimAdditionalInfo - 有关所请求声明的其他信息

requestClaimInIdToken

public void requestClaimInIdToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

将声明插入要添加到 OIDC 声明请求的“id_token”部分中的声明列表中

参数:

claim - 要请求的声明的名称
requestedClaimAdditionalInfo - 有关所请求声明的其他信息

requestClaimInUserInfo

protected void requestClaimInUserInfo(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

将声明插入要添加到 OIDC 声明请求的“userinfo”部分的声明列表中

参数:

claim - 要请求的声明的名称
requestedClaimAdditionalInfo - 有关所请求声明的其他信息

setIdTokenRequestedClaims

public void setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)

参数:

idTokenRequestedClaims

适用于