com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.yml

### YamlMime:JavaType
uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder"
fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder"
name: "AuthorizationRequestUrlParameters.Builder"
nameWithType: "AuthorizationRequestUrlParameters.Builder"
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 static class **AuthorizationRequestUrlParameters.Builder**"
constructors:
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.Builder()"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.Builder()"
  name: "Builder()"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.Builder()"
  syntax: "public Builder()"
methods:
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.build()"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.build()"
  name: "build()"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.build()"
  syntax: "public AuthorizationRequestUrlParameters build()"
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters&text=AuthorizationRequestUrlParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.claims(com.microsoft.aad.msal4j.ClaimsRequest)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.claims(ClaimsRequest val)"
  name: "claims(ClaimsRequest val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.claims(ClaimsRequest val)"
  summary: "Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims"
  parameters:
  - name: "val"
    type: "<xref href=\"com.microsoft.aad.msal4j.ClaimsRequest?alt=com.microsoft.aad.msal4j.ClaimsRequest&text=ClaimsRequest\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder claims(ClaimsRequest val)"
  desc: "Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims"
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.claimsChallenge(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.claimsChallenge(String val)"
  name: "claimsChallenge(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.claimsChallenge(String val)"
  summary: "In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met,<xref uid=\"com.microsoft.aad.msal4j.MsalServiceException\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MsalServiceException\"></xref> will contain claims that need be consented to."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder claimsChallenge(String val)"
  desc: "In cases where Azure AD tenant admin has enabled conditional access policies, and the policy has not been met,<xref uid=\"com.microsoft.aad.msal4j.MsalServiceException\" data-throw-if-not-resolved=\"false\" data-raw-source=\"MsalServiceException\"></xref> will contain claims that need be consented to."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.codeChallenge(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.codeChallenge(String val)"
  name: "codeChallenge(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.codeChallenge(String val)"
  summary: "Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE)."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder codeChallenge(String val)"
  desc: "Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). Required if codeChallenge is included. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636"
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.codeChallengeMethod(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.codeChallengeMethod(String val)"
  name: "codeChallengeMethod(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.codeChallengeMethod(String val)"
  summary: "The method used to encode the code verifier for the code challenge parameter."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder codeChallengeMethod(String val)"
  desc: "The method used to encode the code verifier for the code challenge parameter. Can be one of plain or S256. If excluded, code challenge is assumed to be plaintext. For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636"
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.correlationId(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.correlationId(String val)"
  name: "correlationId(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.correlationId(String val)"
  summary: "Identifier used to correlate requests for telemetry purposes."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder correlationId(String val)"
  desc: "Identifier used to correlate requests for telemetry purposes. Usually a GUID."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.domainHint(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.domainHint(String val)"
  name: "domainHint(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.domainHint(String val)"
  summary: "Provides a hint about the tenant or domain that the user should use to sign in."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder domainHint(String val)"
  desc: "Provides a hint about the tenant or domain that the user should use to sign in. The value of the domain hint is a registered domain for the tenant."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.extraQueryParameters(java.util.Map<java.lang.String,java.lang.String>)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.extraQueryParameters(Map<String,String> val)"
  name: "extraQueryParameters(Map<String,String> val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.extraQueryParameters(Map<String,String> val)"
  summary: "Query parameters that you can add to the request, in addition to the list of parameters already provided."
  parameters:
  - name: "val"
    type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public AuthorizationRequestUrlParameters.Builder extraQueryParameters(Map<String,String> val)"
  desc: "Query parameters that you can add to the request, in addition to the list of parameters already provided."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.extraScopesToConsent(java.util.Set<java.lang.String>)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.extraScopesToConsent(Set<String> val)"
  name: "extraScopesToConsent(Set<String> val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.extraScopesToConsent(Set<String> val)"
  summary: "Scopes that you can request the end user to consent upfront, in addition to scopes which the application is requesting access to."
  parameters:
  - name: "val"
    type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public AuthorizationRequestUrlParameters.Builder extraScopesToConsent(Set<String> val)"
  desc: "Scopes that you can request the end user to consent upfront, in addition to scopes which the application is requesting access to."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.instanceAware(boolean)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.instanceAware(boolean val)"
  name: "instanceAware(boolean val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.instanceAware(boolean val)"
  summary: "If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application."
  parameters:
  - name: "val"
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder instanceAware(boolean val)"
  desc: "If set to true, the authorization result will contain the authority for the user's home cloud, and this authority will be used for the token request instead of the authority set in the application."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.loginHint(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.loginHint(String val)"
  name: "loginHint(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.loginHint(String val)"
  summary: "Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder loginHint(String val)"
  desc: "Can be used to pre-fill the username/email address field of the sign-in page for the user, if you know the username/email address ahead of time. Often apps use this parameter during re-authentication, having already extracted the username from a previous sign-in using the preferred\\_username claim."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.nonce(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.nonce(String val)"
  name: "nonce(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.nonce(String val)"
  summary: "A value included in the request that is also returned in the token response."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder nonce(String val)"
  desc: "A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.prompt(com.microsoft.aad.msal4j.Prompt)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.prompt(Prompt val)"
  name: "prompt(Prompt val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.prompt(Prompt val)"
  summary: "Indicates the type of user interaction that is required."
  parameters:
  - name: "val"
    type: "<xref href=\"com.microsoft.aad.msal4j.Prompt?alt=com.microsoft.aad.msal4j.Prompt&text=Prompt\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder prompt(Prompt val)"
  desc: "Indicates the type of user interaction that is required. Possible values are <xref uid=\"com.microsoft.aad.msal4j.Prompt\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Prompt\"></xref>"
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.redirectUri(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.redirectUri(String val)"
  name: "redirectUri(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.redirectUri(String val)"
  summary: "The redirect URI where authentication responses can be received by your application."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder redirectUri(String val)"
  desc: "The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.responseMode(com.microsoft.aad.msal4j.ResponseMode)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.responseMode(ResponseMode val)"
  name: "responseMode(ResponseMode val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.responseMode(ResponseMode val)"
  summary: "Specifies the method that should be used to send the authentication result to your app."
  parameters:
  - name: "val"
    type: "<xref href=\"com.microsoft.aad.msal4j.ResponseMode?alt=com.microsoft.aad.msal4j.ResponseMode&text=ResponseMode\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder responseMode(ResponseMode val)"
  desc: "Specifies the method that should be used to send the authentication result to your app."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.scopes(java.util.Set<java.lang.String>)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.scopes(Set<String> val)"
  name: "scopes(Set<String> val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.scopes(Set<String> val)"
  summary: "Scopes which the application is requesting access to and the user will consent to."
  parameters:
  - name: "val"
    type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public AuthorizationRequestUrlParameters.Builder scopes(Set<String> val)"
  desc: "Scopes which the application is requesting access to and the user will consent to."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.state(java.lang.String)"
  fullName: "com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder.state(String val)"
  name: "state(String val)"
  nameWithType: "AuthorizationRequestUrlParameters.Builder.state(String val)"
  summary: "A value included in the request that is also returned in the token response."
  parameters:
  - name: "val"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public AuthorizationRequestUrlParameters.Builder state(String val)"
  desc: "A value included in the request that is also returned in the token response. A randomly generated unique value is typically used for preventing cross site request forgery attacks. The state is also used to encode information about the user's state in the app before the authentication request occurred."
  returns:
    type: "<xref href=\"com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder?alt=com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder&text=Builder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
metadata: {}
package: "com.microsoft.aad.msal4j"
artifact: com.microsoft.azure:msal4j:1.17.2