com.microsoft.aad.msal4j

Class ClaimsRequest

java.lang.Object

com.microsoft.aad.msal4j.ClaimsRequest

All Implemented Interfaces:

com.azure.json.JsonSerializable<ClaimsRequest>

public class ClaimsRequest
extends Object
implements com.azure.json.JsonSerializable<ClaimsRequest>

Represents the claims request parameter as an object

See Also:

https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter

Constructor Summary

Constructors

Constructor and Description
ClaimsRequest()

Method Summary

Modifier and Type	Method and Description
static ClaimsRequest	formatAsClaimsRequest(String claims) Creates an instance of ClaimsRequest from a JSON-formatted String which follows the specification for the OIDC claims request parameter
String	formatAsJSONString() Converts the ClaimsRequest object to a JSON-formatted String which follows the specification for the OIDC claims request parameter
List<RequestedClaim>	getIdTokenRequestedClaims()
protected void	requestClaimInAccessToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo) Inserts a claim into the list of claims to be added to the "access_token" section of an OIDC claims request
void	requestClaimInIdToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo) Inserts a claim into the list of claims to be added to the "id_token" section of an OIDC claims request
protected void	requestClaimInUserInfo(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo) Inserts a claim into the list of claims to be added to the "userinfo" section of an OIDC claims request
void	setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

fromJson, fromJson, fromJson, fromJson, fromJson, toJson, toJson, toJsonBytes, toJsonString

Constructor Detail

ClaimsRequest

public ClaimsRequest()

Method Detail

requestClaimInIdToken

public void requestClaimInIdToken(String claim,
                                  RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

Inserts a claim into the list of claims to be added to the "id_token" section of an OIDC claims request

Parameters:

claim - the name of the claim to be requested

requestedClaimAdditionalInfo - additional information about the claim being requested

requestClaimInUserInfo

protected void requestClaimInUserInfo(String claim,
                                      RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

Inserts a claim into the list of claims to be added to the "userinfo" section of an OIDC claims request

Parameters:

claim - the name of the claim to be requested

requestedClaimAdditionalInfo - additional information about the claim being requested

requestClaimInAccessToken

protected void requestClaimInAccessToken(String claim,
                                         RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)

Inserts a claim into the list of claims to be added to the "access_token" section of an OIDC claims request

Parameters:

claim - the name of the claim to be requested

requestedClaimAdditionalInfo - additional information about the claim being requested

formatAsJSONString

public String formatAsJSONString()

Converts the ClaimsRequest object to a JSON-formatted String which follows the specification for the OIDC claims request parameter

Returns:

a String following JSON formatting

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<ClaimsRequest>

Throws:

IOException

formatAsClaimsRequest

public static ClaimsRequest formatAsClaimsRequest(String claims)

Creates an instance of ClaimsRequest from a JSON-formatted String which follows the specification for the OIDC claims request parameter

Parameters:

claims - a String following JSON formatting

Returns:

a ClaimsRequest instance

getIdTokenRequestedClaims

public List<RequestedClaim> getIdTokenRequestedClaims()

setIdTokenRequestedClaims

public void setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)