com.microsoft.identity.client.claims

Class ClaimsRequest

java.lang.Object

com.microsoft.identity.client.claims.ClaimsRequest

public class ClaimsRequest
extends java.lang.Object

Represents the claims request parameter as an object

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_TOKEN
static java.lang.String	ID_TOKEN
static java.lang.String	USERINFO

Constructor Summary

Constructors

Constructor and Description
ClaimsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.List<RequestedClaim>	getAccessTokenClaimsRequested() Return the list of requested claims for an Access Token in the claims request parameter object
static ClaimsRequest	getClaimsRequestFromJsonString(java.lang.String claimsRequestJson) Returns a claims request parameter object based on the JSON representation of the same.
java.util.List<RequestedClaim>	getIdTokenClaimsRequested() Return the list of requested claims for an ID Token in the claims request parameter object
static java.lang.String	getJsonStringFromClaimsRequest(ClaimsRequest claimsRequest) Returns the JSON representation of the claims request parameter
java.util.List<RequestedClaim>	getUserInfoClaimsRequested() Return the list of requested claims for the userinfo endpoint in the claims request parameter object
int	hashCode()
void	requestClaimInAccessToken(java.lang.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(java.lang.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(java.lang.String name, RequestedClaimAdditionalInformation additionalInformation) Adds a request for a specific claim to be included in the userinfo response via the claims request parameter

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

USERINFO

public static final java.lang.String USERINFO

See Also:

Constant Field Values

ID_TOKEN

public static final java.lang.String ID_TOKEN

See Also:

Constant Field Values

ACCESS_TOKEN

public static final java.lang.String ACCESS_TOKEN

See Also:

Constant Field Values

Constructor Detail

ClaimsRequest

public ClaimsRequest()

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getUserInfoClaimsRequested

public java.util.List<RequestedClaim> getUserInfoClaimsRequested()

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

Returns:

getAccessTokenClaimsRequested

public java.util.List<RequestedClaim> getAccessTokenClaimsRequested()

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

Returns:

getIdTokenClaimsRequested

public java.util.List<RequestedClaim> getIdTokenClaimsRequested()

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

Returns:

getClaimsRequestFromJsonString

public static ClaimsRequest getClaimsRequestFromJsonString(java.lang.String claimsRequestJson)

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

Parameters:

claimsRequestJson -

Returns:

See Also:

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

getJsonStringFromClaimsRequest

public static java.lang.String getJsonStringFromClaimsRequest(ClaimsRequest claimsRequest)

Returns the JSON representation of the claims request parameter

Parameters:

claimsRequest -

Returns:

See Also:

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

requestClaimInAccessToken

public void requestClaimInAccessToken(java.lang.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(java.lang.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(java.lang.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 -