Class LogoutAuthenticationPropertiesBuilder

Namespace

Auth0.AspNetCore.Authentication

Assembly

Auth0.AspNetCore.Authentication.dll

Builder class for AuthenticationProperties when calling logout.

public class LogoutAuthenticationPropertiesBuilder : BaseAuthenticationPropertiesBuilder

Inheritance

object

BaseAuthenticationPropertiesBuilder

LogoutAuthenticationPropertiesBuilder

Inherited Members

BaseAuthenticationPropertiesBuilder.AuthenticationProperties

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Allows for Auth0 specific first-class properties when constructing an instance of AuthenticationProperties.

Constructors

LogoutAuthenticationPropertiesBuilder(AuthenticationProperties?)

public LogoutAuthenticationPropertiesBuilder(AuthenticationProperties? properties = null)

Parameters

properties AuthenticationProperties

Methods

Build()

Return the configured AuthenticationProperties.

public AuthenticationProperties Build()

Returns

AuthenticationProperties

The configured AuthenticationProperties

WithParameter(string, string?)

Build the AuthenticationProperties using a parameter that will be sent to Auth0's logout endpoint.

public LogoutAuthenticationPropertiesBuilder WithParameter(string key, string? value = null)

Parameters

key string

The key for the parameter.

value string

The value for the parameter.

Returns

LogoutAuthenticationPropertiesBuilder

The current LogoutAuthenticationPropertiesBuilder instance.

WithRedirectUri(string)

Build the AuthenticationProperties using the provided redirect URI

public LogoutAuthenticationPropertiesBuilder WithRedirectUri(string redirectUri)

Parameters

redirectUri string

Full path or absolute URI to be used to redirect back to your application.

Returns

LogoutAuthenticationPropertiesBuilder

The current LogoutAuthenticationPropertiesBuilder instance.

Remarks

Defaults to "/" when WithRedirectUri(string) is not called while building the AuthenticationProperties.