Class RateLimit

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

Represents rate limit information returned by the Management API on a TooManyRequestsError (HTTP 429) response.

public sealed class RateLimit

Inheritance

object

RateLimit

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Extension Methods

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

Properties

ClientQuotaLimit

Client-level quota information, from the Auth0-Client-Quota-Limit header. null if the header was absent or malformed.

public ClientQuotaLimit? ClientQuotaLimit { get; init; }

Property Value

ClientQuotaLimit

Limit

The maximum number of requests the consumer is allowed to make, from the x-ratelimit-limit header. null if the header was absent.

public long? Limit { get; init; }

Property Value

long?

OrganizationQuotaLimit

Organization-level quota information, from the Auth0-Organization-Quota-Limit header. null if the header was absent or malformed.

public OrganizationQuotaLimit? OrganizationQuotaLimit { get; init; }

Property Value

OrganizationQuotaLimit

Remaining

The number of requests remaining in the current rate limit window, from the x-ratelimit-remaining header. null if the header was absent.

public long? Remaining { get; init; }

Property Value

long?

Reset

The date and time at which the current rate limit window resets, from the x-ratelimit-reset header (Unix epoch seconds). null if the header was absent.

public DateTimeOffset? Reset { get; init; }

Property Value

DateTimeOffset?

RetryAfter

The time to wait before retrying, from the retry-after header. null if the header was absent.

public TimeSpan? RetryAfter { get; init; }

Property Value

TimeSpan?

Methods

Parse(ResponseHeaders)

Parses rate limit information from the supplied response headers.

public static RateLimit Parse(ResponseHeaders headers)

Parameters

headers ResponseHeaders

Returns

RateLimit