com.microsoft.aad.msal4j.ClaimsRequest.yml

### YamlMime:JavaType
uid: "com.microsoft.aad.msal4j.ClaimsRequest"
fullName: "com.microsoft.aad.msal4j.ClaimsRequest"
name: "ClaimsRequest"
nameWithType: "ClaimsRequest"
summary: "Represents the claims request parameter as an object"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **ClaimsRequest**"
constructors:
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.ClaimsRequest()"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.ClaimsRequest()"
  name: "ClaimsRequest()"
  nameWithType: "ClaimsRequest.ClaimsRequest()"
  syntax: "public ClaimsRequest()"
methods:
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.formatAsClaimsRequest(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.formatAsClaimsRequest(String claims)"
  name: "formatAsClaimsRequest(String claims)"
  nameWithType: "ClaimsRequest.formatAsClaimsRequest(String claims)"
  summary: "Creates an instance of Claims<wbr>Request from a JSON-formatted String which follows the specification for the OIDC claims request parameter"
  modifiers:
  - "static"
  parameters:
  - description: "a String following JSON formatting"
    name: "claims"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static ClaimsRequest formatAsClaimsRequest(String claims)"
  desc: "Creates an instance of ClaimsRequest from a JSON-formatted String which follows the specification for the OIDC claims request parameter"
  returns:
    description: "a ClaimsRequest instance"
    type: "<xref href=\"com.microsoft.aad.msal4j.ClaimsRequest?alt=com.microsoft.aad.msal4j.ClaimsRequest&text=ClaimsRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.formatAsJSONString()"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.formatAsJSONString()"
  name: "formatAsJSONString()"
  nameWithType: "ClaimsRequest.formatAsJSONString()"
  summary: "Converts the Claims<wbr>Request object to a JSON-formatted String which follows the specification for the OIDC claims request parameter"
  syntax: "public String formatAsJSONString()"
  desc: "Converts the ClaimsRequest object to a JSON-formatted String which follows the specification for the OIDC claims request parameter"
  returns:
    description: "a String following JSON formatting"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.getIdTokenRequestedClaims()"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.getIdTokenRequestedClaims()"
  name: "getIdTokenRequestedClaims()"
  nameWithType: "ClaimsRequest.getIdTokenRequestedClaims()"
  syntax: "public List<RequestedClaim> getIdTokenRequestedClaims()"
  returns:
    type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.aad.msal4j.RequestedClaim?alt=com.microsoft.aad.msal4j.RequestedClaim&text=RequestedClaim\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.requestClaimInAccessToken(java.lang.String,com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo)"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.requestClaimInAccessToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  name: "requestClaimInAccessToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  nameWithType: "ClaimsRequest.requestClaimInAccessToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  summary: "Inserts a claim into the list of claims to be added to the \"access\\_token\" section of an OIDC claims request"
  modifiers:
  - "protected"
  parameters:
  - description: "the name of the claim to be requested"
    name: "claim"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "additional information about the claim being requested"
    name: "requestedClaimAdditionalInfo"
    type: "<xref href=\"com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo?alt=com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo&text=RequestedClaimAdditionalInfo\" data-throw-if-not-resolved=\"False\" />"
  syntax: "protected void requestClaimInAccessToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  desc: "Inserts a claim into the list of claims to be added to the \"access\\_token\" section of an OIDC claims request"
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.requestClaimInIdToken(java.lang.String,com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo)"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.requestClaimInIdToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  name: "requestClaimInIdToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  nameWithType: "ClaimsRequest.requestClaimInIdToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  summary: "Inserts a claim into the list of claims to be added to the \"id\\_token\" section of an OIDC claims request"
  parameters:
  - description: "the name of the claim to be requested"
    name: "claim"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "additional information about the claim being requested"
    name: "requestedClaimAdditionalInfo"
    type: "<xref href=\"com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo?alt=com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo&text=RequestedClaimAdditionalInfo\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public void requestClaimInIdToken(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  desc: "Inserts a claim into the list of claims to be added to the \"id\\_token\" section of an OIDC claims request"
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.requestClaimInUserInfo(java.lang.String,com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo)"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.requestClaimInUserInfo(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  name: "requestClaimInUserInfo(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  nameWithType: "ClaimsRequest.requestClaimInUserInfo(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  summary: "Inserts a claim into the list of claims to be added to the \"userinfo\" section of an OIDC claims request"
  modifiers:
  - "protected"
  parameters:
  - description: "the name of the claim to be requested"
    name: "claim"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  - description: "additional information about the claim being requested"
    name: "requestedClaimAdditionalInfo"
    type: "<xref href=\"com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo?alt=com.microsoft.aad.msal4j.RequestedClaimAdditionalInfo&text=RequestedClaimAdditionalInfo\" data-throw-if-not-resolved=\"False\" />"
  syntax: "protected void requestClaimInUserInfo(String claim, RequestedClaimAdditionalInfo requestedClaimAdditionalInfo)"
  desc: "Inserts a claim into the list of claims to be added to the \"userinfo\" section of an OIDC claims request"
- uid: "com.microsoft.aad.msal4j.ClaimsRequest.setIdTokenRequestedClaims(java.util.List<com.microsoft.aad.msal4j.RequestedClaim>)"
  fullName: "com.microsoft.aad.msal4j.ClaimsRequest.setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)"
  name: "setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)"
  nameWithType: "ClaimsRequest.setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)"
  parameters:
  - name: "idTokenRequestedClaims"
    type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.aad.msal4j.RequestedClaim?alt=com.microsoft.aad.msal4j.RequestedClaim&text=RequestedClaim\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void setIdTokenRequestedClaims(List<RequestedClaim> idTokenRequestedClaims)"
type: "class"
desc: "Represents the claims request parameter as an object"
metadata: {}
package: "com.microsoft.aad.msal4j"
artifact: com.microsoft.azure:msal4j:1.17.2