ClaimsRequest Class

Package:

com.microsoft.identity.client.claims

• java.lang.Object
• • com.microsoft.identity.client.claims.ClaimsRequest

public class ClaimsRequest

Represents the claims request parameter as an object

Field Summary

Modifier and Type	Field and Description
final String	ACCESS_TOKEN
final String	ID_TOKEN
final String	USERINFO

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<RequestedClaim>	getAccessTokenClaimsRequested() Return the list of requested claims for an Access Token in the claims request parameter object
ClaimsRequest	getClaimsRequestFromJsonString(String claimsRequestJson) Returns a claims request parameter object based on the JSON representation of the same.
List<RequestedClaim>	getIdTokenClaimsRequested() Return the list of requested claims for an ID Token in the claims request parameter object
String	getJsonStringFromClaimsRequest(@Nullable final ClaimsRequest claimsRequest) Returns the JSON representation of the claims request parameter
List<RequestedClaim>	getUserInfoClaimsRequested() Return the list of requested claims for the userinfo endpoint in the claims request parameter object
int	hashCode()
void	requestClaimInAccessToken(String name, RequestedClaimAdditionalInformation additionalInformation) Adds a request for a specific claim to be included in an access token via the claims request parameter
void	requestClaimInIdToken(String name, RequestedClaimAdditionalInformation additionalInformation) Adds a request for a specific claim to be included in an id token via the claims request parameter
void	requestClaimInUserInfo(String name, RequestedClaimAdditionalInformation additionalInformation) Adds a request for a specific claim to be included in the userinfo response via the claims request parameter

Field Details

ACCESS_TOKEN

public static final String ACCESS_TOKEN= "access_token"

ID_TOKEN

public static final String ID_TOKEN= "id_token"

USERINFO

public static final String USERINFO= "userinfo"

Method Details

equals

public boolean equals(Object o)

Parameters:

o

getAccessTokenClaimsRequested

public List getAccessTokenClaimsRequested()

Return the list of requested claims for an Access Token in the claims request parameter object

getClaimsRequestFromJsonString

public static ClaimsRequest getClaimsRequestFromJsonString(String claimsRequestJson)

Returns a claims request parameter object based on the JSON representation of the same.

Parameters:

claimsRequestJson

getIdTokenClaimsRequested

public List getIdTokenClaimsRequested()

Return the list of requested claims for an ID Token in the claims request parameter object

getJsonStringFromClaimsRequest

public static String getJsonStringFromClaimsRequest(@Nullable final ClaimsRequest claimsRequest)

Returns the JSON representation of the claims request parameter

Parameters:

claimsRequest

getUserInfoClaimsRequested

public List getUserInfoClaimsRequested()

Return the list of requested claims for the userinfo endpoint in the claims request parameter object

hashCode

public int hashCode()

requestClaimInAccessToken

public void requestClaimInAccessToken(String name, RequestedClaimAdditionalInformation additionalInformation)

Adds a request for a specific claim to be included in an access token via the claims request parameter

Parameters:

name

additionalInformation

requestClaimInIdToken

public void requestClaimInIdToken(String name, RequestedClaimAdditionalInformation additionalInformation)

Adds a request for a specific claim to be included in an id token via the claims request parameter

Parameters:

name

additionalInformation

requestClaimInUserInfo

public void requestClaimInUserInfo(String name, RequestedClaimAdditionalInformation additionalInformation)

Adds a request for a specific claim to be included in the userinfo response via the claims request parameter

Parameters:

name

additionalInformation