Class ClientOptions

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

[Serializable]
public class ClientOptions

Inheritance

object

ClientOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Constructors

ClientOptions()

public ClientOptions()

Properties

AdditionalHeaders

Additional headers to be sent with HTTP requests. Headers with matching keys will be overwritten by headers set on the request.

public IEnumerable<KeyValuePair<string, string?>> AdditionalHeaders { get; set; }

Property Value

IEnumerable<KeyValuePair<string, string>>

BaseUrl

The Base URL for the API.

public string BaseUrl { get; set; }

Property Value

string

CustomDomain

Sets the Auth0-Custom-Domain header value sent on Management API requests that generate user-facing links (email verification, password reset, invitations, etc.).

When set, the header is included in every outgoing request. To restrict the header to only the whitelisted endpoints and strip it from all others, also configure your HttpClient with a CustomDomainInterceptor handler:

new ClientOptions
{
    CustomDomain = "login.mycompany.com",
    HttpClient   = new HttpClient(new CustomDomainInterceptor())
}

If you are using ManagementClient, stripping is configured automatically when no custom HttpClient is provided - prefer that path.

public string? CustomDomain { get; set; }

Property Value

string

Exceptions

ArgumentException

Thrown when the value is non-null but empty or contains only whitespace.

HttpClient

The http client used to make requests.

public HttpClient HttpClient { get; set; }

Property Value

HttpClient

MaxRetries

The max number of retries to attempt.

public int MaxRetries { get; set; }

Property Value

int

Timeout

The timeout for the request.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan