azure-docs-sdk-java/docs-ref-autogen/com.microsoft.identity.client.claims.ClaimsRequest.yml

### YamlMime:JavaType
fields:
- field:
    type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
  fullName: com.microsoft.identity.client.claims.ClaimsRequest.ACCESS_TOKEN
  name: ACCESS_TOKEN
  nameWithType: ClaimsRequest.ACCESS_TOKEN
  syntax: public static final String ACCESS_TOKEN= "access_token"
  uid: com.microsoft.identity.client.claims.ClaimsRequest.ACCESS_TOKEN
- field:
    type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
  fullName: com.microsoft.identity.client.claims.ClaimsRequest.ID_TOKEN
  name: ID_TOKEN
  nameWithType: ClaimsRequest.ID_TOKEN
  syntax: public static final String ID_TOKEN= "id_token"
  uid: com.microsoft.identity.client.claims.ClaimsRequest.ID_TOKEN
- field:
    type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
  fullName: com.microsoft.identity.client.claims.ClaimsRequest.USERINFO
  name: USERINFO
  nameWithType: ClaimsRequest.USERINFO
  syntax: public static final String USERINFO= "userinfo"
  uid: com.microsoft.identity.client.claims.ClaimsRequest.USERINFO
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
methods:
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.equals(Object o)
  name: equals(Object o)
  nameWithType: ClaimsRequest.equals(Object o)
  parameters:
  - name: o
    type: <xref href="Object?alt=Object&text=Object" data-throw-if-not-resolved="False"/>
  returns:
    type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
  syntax: public boolean equals(Object o)
  uid: com.microsoft.identity.client.claims.ClaimsRequest.equals(Object)
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.getAccessTokenClaimsRequested()
  name: getAccessTokenClaimsRequested()
  nameWithType: ClaimsRequest.getAccessTokenClaimsRequested()
  returns:
    type: List&lt;<xref href="com.microsoft.identity.client.claims.RequestedClaim?alt=com.microsoft.identity.client.claims.RequestedClaim&text=RequestedClaim" data-throw-if-not-resolved="False"/>&gt;
  summary: >-
    <p>Return the list of requested claims for an Access Token in the claims request parameter object</p>

    <p></p>    
  syntax: public List<RequestedClaim> getAccessTokenClaimsRequested()
  uid: com.microsoft.identity.client.claims.ClaimsRequest.getAccessTokenClaimsRequested()
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.getClaimsRequestFromJsonString(String claimsRequestJson)
  name: getClaimsRequestFromJsonString(String claimsRequestJson)
  nameWithType: ClaimsRequest.getClaimsRequestFromJsonString(String claimsRequestJson)
  parameters:
  - name: claimsRequestJson
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  returns:
    type: <xref href="com.microsoft.identity.client.claims.ClaimsRequest?alt=com.microsoft.identity.client.claims.ClaimsRequest&text=ClaimsRequest" data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Returns a claims request parameter object based on the JSON representation of the same.</p>

    <p></p>    
  syntax: public static ClaimsRequest getClaimsRequestFromJsonString(String claimsRequestJson)
  uid: com.microsoft.identity.client.claims.ClaimsRequest.getClaimsRequestFromJsonString(String)
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.getIdTokenClaimsRequested()
  name: getIdTokenClaimsRequested()
  nameWithType: ClaimsRequest.getIdTokenClaimsRequested()
  returns:
    type: List&lt;<xref href="com.microsoft.identity.client.claims.RequestedClaim?alt=com.microsoft.identity.client.claims.RequestedClaim&text=RequestedClaim" data-throw-if-not-resolved="False"/>&gt;
  summary: >-
    <p>Return the list of requested claims for an ID Token in the claims request parameter object</p>

    <p></p>    
  syntax: public List<RequestedClaim> getIdTokenClaimsRequested()
  uid: com.microsoft.identity.client.claims.ClaimsRequest.getIdTokenClaimsRequested()
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.getJsonStringFromClaimsRequest(@Nullable final ClaimsRequest claimsRequest)
  name: getJsonStringFromClaimsRequest(@Nullable final ClaimsRequest claimsRequest)
  nameWithType: ClaimsRequest.getJsonStringFromClaimsRequest(@Nullable final ClaimsRequest claimsRequest)
  parameters:
  - name: claimsRequest
    type: '@Nullable final <xref href="com.microsoft.identity.client.claims.ClaimsRequest?alt=com.microsoft.identity.client.claims.ClaimsRequest&text=ClaimsRequest" data-throw-if-not-resolved="False"/>'
  returns:
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Returns the JSON representation of the claims request parameter</p>

    <p></p>    
  syntax: public static String getJsonStringFromClaimsRequest(@Nullable final ClaimsRequest claimsRequest)
  uid: com.microsoft.identity.client.claims.ClaimsRequest.getJsonStringFromClaimsRequest(@Nullable final ClaimsRequest)
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.getUserInfoClaimsRequested()
  name: getUserInfoClaimsRequested()
  nameWithType: ClaimsRequest.getUserInfoClaimsRequested()
  returns:
    type: List&lt;<xref href="com.microsoft.identity.client.claims.RequestedClaim?alt=com.microsoft.identity.client.claims.RequestedClaim&text=RequestedClaim" data-throw-if-not-resolved="False"/>&gt;
  summary: >-
    <p>Return the list of requested claims for the userinfo endpoint in the claims request parameter object</p>

    <p></p>    
  syntax: public List<RequestedClaim> getUserInfoClaimsRequested()
  uid: com.microsoft.identity.client.claims.ClaimsRequest.getUserInfoClaimsRequested()
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.hashCode()
  name: hashCode()
  nameWithType: ClaimsRequest.hashCode()
  returns:
    type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
  syntax: public int hashCode()
  uid: com.microsoft.identity.client.claims.ClaimsRequest.hashCode()
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.requestClaimInAccessToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  name: requestClaimInAccessToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  nameWithType: ClaimsRequest.requestClaimInAccessToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  parameters:
  - name: name
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  - name: additionalInformation
    type: <xref href="com.microsoft.identity.client.claims.RequestedClaimAdditionalInformation?alt=com.microsoft.identity.client.claims.RequestedClaimAdditionalInformation&text=RequestedClaimAdditionalInformation" data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Adds a request for a specific claim to be included in an access token via the claims request parameter</p>

    <p></p>    
  syntax: public void requestClaimInAccessToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  uid: com.microsoft.identity.client.claims.ClaimsRequest.requestClaimInAccessToken(String,RequestedClaimAdditionalInformation)
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.requestClaimInIdToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  name: requestClaimInIdToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  nameWithType: ClaimsRequest.requestClaimInIdToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  parameters:
  - name: name
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  - name: additionalInformation
    type: <xref href="com.microsoft.identity.client.claims.RequestedClaimAdditionalInformation?alt=com.microsoft.identity.client.claims.RequestedClaimAdditionalInformation&text=RequestedClaimAdditionalInformation" data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Adds a request for a specific claim to be included in an id token via the claims request parameter</p>

    <p></p>    
  syntax: public void requestClaimInIdToken(String name, RequestedClaimAdditionalInformation additionalInformation)
  uid: com.microsoft.identity.client.claims.ClaimsRequest.requestClaimInIdToken(String,RequestedClaimAdditionalInformation)
- fullName: com.microsoft.identity.client.claims.ClaimsRequest.requestClaimInUserInfo(String name, RequestedClaimAdditionalInformation additionalInformation)
  name: requestClaimInUserInfo(String name, RequestedClaimAdditionalInformation additionalInformation)
  nameWithType: ClaimsRequest.requestClaimInUserInfo(String name, RequestedClaimAdditionalInformation additionalInformation)
  parameters:
  - name: name
    type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
  - name: additionalInformation
    type: <xref href="com.microsoft.identity.client.claims.RequestedClaimAdditionalInformation?alt=com.microsoft.identity.client.claims.RequestedClaimAdditionalInformation&text=RequestedClaimAdditionalInformation" data-throw-if-not-resolved="False"/>
  summary: >-
    <p>Adds a request for a specific claim to be included in the userinfo response via the claims request parameter</p>

    <p></p>    
  syntax: public void requestClaimInUserInfo(String name, RequestedClaimAdditionalInformation additionalInformation)
  uid: com.microsoft.identity.client.claims.ClaimsRequest.requestClaimInUserInfo(String,RequestedClaimAdditionalInformation)
nameWithType: ClaimsRequest
syntax: public class ClaimsRequest
type: class
uid: com.microsoft.identity.client.claims.ClaimsRequest
fullName: com.microsoft.identity.client.claims.ClaimsRequest
name: ClaimsRequest
package: com.microsoft.identity.client.claims
summary: >-
  <p>Represents the claims request parameter as an object</p>

  <p></p>  
metadata: {}