Class Auth0ClientOptions

Namespace

Auth0.OidcClient

Assembly

Auth0.OidcClient.Core.dll

Specifies options that can be passed to Auth0ClientBase implementations.

public class Auth0ClientOptions

Inheritance

object

Auth0ClientOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Auth0ClientOptions()

Create a new instance of the Auth0ClientOptions class used to configure options for Auth0ClientBase implementations by way of their constructors.

public Auth0ClientOptions()

Properties

BackchannelHandler

Allow overriding the BackchannelHandler.

public HttpMessageHandler BackchannelHandler { get; set; }

Property Value

HttpMessageHandler

Examples

var handler = new HttpClientHandler();
var options = new Auth0ClientOptions
{
   BackchannelHandler = handler
};

Browser

The IdentityModel.OidcClient.Browser.IBrowser implementation responsible for displaying the Auth0 Login screen. Leave this unassigned to accept the recommended implementation for platform.

public IBrowser Browser { get; set; }

Property Value

IBrowser

ClientId

Your Auth0 Client ID.

public string ClientId { get; set; }

Property Value

string

Domain

Your Auth0 tenant domain.

public string Domain { get; set; }

Property Value

string

Remarks

e.g. tenant.auth0.com

EnableTelemetry

Indicates whether basic telemetry information should be included with requests to Auth0.

public bool EnableTelemetry { get; set; }

Property Value

bool

Remarks

The telemetry information is like a browser user agent and includes operating system details only to let Auth0 guide engineering resources based on platform popularity.

Leeway

The amount of leeway to accommodate potential clock skew when validating an ID token's claims. Defaults to 5 minutes.

public TimeSpan Leeway { get; set; }

Property Value

TimeSpan

LoadProfile

Indicates whether the user profile should be loaded from the /userinfo endpoint.

public bool LoadProfile { get; set; }

Property Value

bool

Remarks

Defaults to true.

LoggerFactory

Optional ILoggerFactory implementation to use for logging purposes.

public ILoggerFactory LoggerFactory { get; set; }

Property Value

ILoggerFactory

MaxAge

Optional limit on the how long since the user was last authenticated.

public TimeSpan? MaxAge { get; set; }

Property Value

TimeSpan?

PostLogoutRedirectUri

Override the Redirect URI used to return from logout.

public string PostLogoutRedirectUri { get; set; }

Property Value

string

Remarks

Defaults to a platform-specific value you can observe in the debug console window when performing a logout. On iOS this is made from the app bundle ID and on Android from a lower-cased version of the package name. Whether you use the default or manually set this value it must be added to the Allowed Logout URLs for this application/client to allow the logout process to complete.

RedirectUri

Override the the Redirect URI used to return from login.

public string RedirectUri { get; set; }

Property Value

string

Remarks

Defaults to a platform-specific value you can observe in the debug console window when performing a login. On iOS this is made from the app bundle ID and on Android from a lower-cased version of the package name. Whether you use the default or manually set this value it must be added to the Allowed Callback URLs for this application/client to allow the login process to complete.

RefreshTokenMessageHandler

Allow overriding the RetryMessageHandler.

public HttpMessageHandler RefreshTokenMessageHandler { get; set; }

Property Value

HttpMessageHandler

Examples

var handler = new HttpClientHandler(); var options = new Auth0ClientOptions { RefreshTokenMessageHandler = handler };

Scope

The scopes you want to request.

public string Scope { get; set; }

Property Value

string