Class RateLimitPoliciesClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class RateLimitPoliciesClient : IRateLimitPoliciesClient

Inheritance

object

RateLimitPoliciesClient

Implements

IRateLimitPoliciesClient

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)

Methods

CreateAsync(CreateRateLimitPolicyRequestContent, RequestOptions?, CancellationToken)

public WithRawResponseTask<CreateRateLimitPolicyResponseContent> CreateAsync(CreateRateLimitPolicyRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateRateLimitPolicyRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateRateLimitPolicyResponseContent>

Examples

await client.RateLimitPolicies.CreateAsync(
    new CreateRateLimitPolicyRequestContent
    {
        Resource = RateLimitPolicyResourceEnum.OauthAuthenticationApi,
        Consumer = RateLimitPolicyConsumerEnum.Client,
        ConsumerSelector = "consumer_selector",
        Configuration = new RateLimitPolicyConfigurationZero
        {
            Action = RateLimitPolicyConfigurationZeroAction.Allow,
        },
    }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

public Task DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.RateLimitPolicies.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

public WithRawResponseTask<GetRateLimitPolicyResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetRateLimitPolicyResponseContent>

Examples

await client.RateLimitPolicies.GetAsync("id");

ListAsync(ListRateLimitPoliciesRequestParameters, RequestOptions?, CancellationToken)

public Task<Pager<RateLimitPolicy>> ListAsync(ListRateLimitPoliciesRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListRateLimitPoliciesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<RateLimitPolicy>>

Examples

await client.RateLimitPolicies.ListAsync(
    new ListRateLimitPoliciesRequestParameters
    {
        Resource = RateLimitPolicyResourceEnum.OauthAuthenticationApi,
        Consumer = RateLimitPolicyConsumerEnum.Client,
        ConsumerSelector = "consumer_selector",
        Take = 1,
        From = "from",
    }
);

UpdateAsync(string, PatchRateLimitPolicyRequestContent, RequestOptions?, CancellationToken)

public WithRawResponseTask<UpdateRateLimitPolicyResponseContent> UpdateAsync(string id, PatchRateLimitPolicyRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request PatchRateLimitPolicyRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateRateLimitPolicyResponseContent>

Examples

await client.RateLimitPolicies.UpdateAsync(
    "id",
    new PatchRateLimitPolicyRequestContent
    {
        Configuration = new PatchRateLimitPolicyConfigurationRequestContentZero
        {
            Action = PatchRateLimitPolicyConfigurationRequestContentZeroAction.Allow,
        },
    }
);