com.auth0.client.auth

Class LogoutUrlBuilder

java.lang.Object

com.auth0.client.auth.LogoutUrlBuilder

public class LogoutUrlBuilder
extends java.lang.Object

Class that provides the methods to generate a valid Auth0 Logout Url. It's based on the https://auth0.com/docs/api/authentication#logout docs.

Method Summary

Modifier and Type	Method and Description
java.lang.String	build() Creates a string representation of the URL with the configured parameters.
LogoutUrlBuilder	useFederated(boolean federated) Request Federated logout.
LogoutUrlBuilder	withAccessToken(java.lang.String accessToken) Sets the access token value.

Methods inherited from class java.lang.Object

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

Method Detail

withAccessToken

public LogoutUrlBuilder withAccessToken(java.lang.String accessToken)

Sets the access token value.

Parameters:

accessToken - access token to set

Returns:

the builder instance

useFederated

public LogoutUrlBuilder useFederated(boolean federated)

Request Federated logout.

Parameters:

federated - whether or not to request Federated logout.

Returns:

the builder instance

build

public java.lang.String build()

Creates a string representation of the URL with the configured parameters.

Returns:

the string URL