Class LogoutUrlBuilder

Namespace

Auth0.AuthenticationApi.Builders

Assembly

Auth0.AuthenticationApi.dll

Builder class used to fluently construct a logout URL.

public class LogoutUrlBuilder : UrlBuilderBase<LogoutUrlBuilder>

Inheritance

object

UrlBuilderBase<LogoutUrlBuilder>

LogoutUrlBuilder

Inherited Members

UrlBuilderBase<LogoutUrlBuilder>.AddUrlSegment(string, string)

UrlBuilderBase<LogoutUrlBuilder>.AddQueryString(string, string)

UrlBuilderBase<LogoutUrlBuilder>.WithValue(string, string)

UrlBuilderBase<LogoutUrlBuilder>.Build()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

See https://auth0.com/docs/api/authentication#logout

Constructors

LogoutUrlBuilder(string)

Initializes a new instance of the LogoutUrlBuilder class.

public LogoutUrlBuilder(string baseUrl)

Parameters

baseUrl string

Base URL of the Authentication API represented as a string.

LogoutUrlBuilder(Uri)

Initializes a new instance of the LogoutUrlBuilder class.

public LogoutUrlBuilder(Uri baseUrl)

Parameters

baseUrl Uri

Base URL of the Authentication API represented as a Uri.

Methods

Federated()

Adds the federated flag query string parameter (no value).

public LogoutUrlBuilder Federated()

Returns

LogoutUrlBuilder

Current LogoutUrlBuilder to allow fluent configuration.

WithClientId(string)

Adds the client_id query string parameter specifying the Client ID of the application.

public LogoutUrlBuilder WithClientId(string clientId)

Parameters

clientId string

Client ID of the application.

Returns

LogoutUrlBuilder

Current LogoutUrlBuilder to allow fluent configuration.

WithReturnUrl(string)

Adds the redirect_uri query string parameter specifying the redirect URI.

public LogoutUrlBuilder WithReturnUrl(string uri)

Parameters

uri string

URI to redirect to.

Returns

LogoutUrlBuilder

Current LogoutUrlBuilder to allow fluent configuration.

WithReturnUrl(Uri)

Adds the redirect_uri query string parameter specifying the redirect URI.

public LogoutUrlBuilder WithReturnUrl(Uri uri)

Parameters

uri Uri

Uri to redirect to.

Returns

LogoutUrlBuilder

Current LogoutUrlBuilder to allow fluent configuration.