com.auth0

Class AuthorizeUrl

java.lang.Object

com.auth0.AuthorizeUrl

public class AuthorizeUrl
extends java.lang.Object

Class to create and customize an Auth0 Authorize URL. It's not reusable.

Method Summary

Modifier and Type	Method and Description
java.lang.String	build() Creates a string representation of the URL with the configured parameters.
AuthorizeUrl	withAudience(java.lang.String audience) Sets the audience value.
AuthorizeUrl	withConnection(java.lang.String connection) Sets the connection value.
AuthorizeUrl	withNonce(java.lang.String nonce) Sets the nonce value.
AuthorizeUrl	withParameter(java.lang.String name, java.lang.String value) Sets an additional parameter.
AuthorizeUrl	withScope(java.lang.String scope) Sets the scope value.
AuthorizeUrl	withSecureCookie(boolean secureCookie) Sets whether cookies used during the authentication flow have the Secure attribute set or not.
AuthorizeUrl	withState(java.lang.String state) Sets the state value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withConnection

public AuthorizeUrl withConnection(java.lang.String connection)

Sets the connection value.

Parameters:

connection - connection to set

Returns:

the builder instance

withSecureCookie

public AuthorizeUrl withSecureCookie(boolean secureCookie)

Sets whether cookies used during the authentication flow have the Secure attribute set or not. By default, cookies will be set with the Secure attribute if the responseType includes id_token and thus requires the SameSite=None cookie attribute set. Setting this to false will not override this behavior, as clients will reject cookies with SameSite=None unless the Secure attribute is set. While not guaranteed by all clients, generally a cookie with the Secure attribute will be rejected unless served over HTTPS.

Parameters:

secureCookie - whether to always set the Secure attribute on all cookies.

Returns:

the builder instance.

withAudience

public AuthorizeUrl withAudience(java.lang.String audience)

Sets the audience value.

Parameters:

audience - audience to set

Returns:

the builder instance

withState

public AuthorizeUrl withState(java.lang.String state)

Sets the state value.

Parameters:

state - state to set

Returns:

the builder instance

withNonce

public AuthorizeUrl withNonce(java.lang.String nonce)

Sets the nonce value.

Parameters:

nonce - nonce to set

Returns:

the builder instance

withScope

public AuthorizeUrl withScope(java.lang.String scope)

Sets the scope value.

Parameters:

scope - scope to set

Returns:

the builder instance

withParameter

public AuthorizeUrl withParameter(java.lang.String name,
                                  java.lang.String value)

Sets an additional parameter.

Parameters:

name - name of the parameter

value - value of the parameter to set

Returns:

the builder instance

build

public java.lang.String build()
                       throws java.lang.IllegalStateException

Creates a string representation of the URL with the configured parameters. It cannot be called more than once.

Returns:

the string URL

Throws:

java.lang.IllegalStateException - if it's called more than once