Get rate limit policies

GET https://{tenantDomain}/api/v2/rate-limit-policies

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

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

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListRateLimitPoliciesRequestParameters;
import com.auth0.client.mgmt.types.RateLimitPolicyConsumerEnum;
import com.auth0.client.mgmt.types.RateLimitPolicyResourceEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.rateLimitPolicies().list(
            ListRateLimitPoliciesRequestParameters
                .builder()
                .resource(RateLimitPolicyResourceEnum.OAUTH_AUTHENTICATION_API)
                .consumer(RateLimitPolicyConsumerEnum.CLIENT)
                .consumerSelector("consumer_selector")
                .take(1)
                .from("from")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\RateLimitPolicies\Requests\ListRateLimitPoliciesRequestParameters;
use Auth0\SDK\API\Management\Types\RateLimitPolicyResourceEnum;
use Auth0\SDK\API\Management\Types\RateLimitPolicyConsumerEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rateLimitPolicies->list(
    new ListRateLimitPoliciesRequestParameters([
        'resource' => RateLimitPolicyResourceEnum::OauthAuthenticationApi->value,
        'consumer' => RateLimitPolicyConsumerEnum::Client->value,
        'consumerSelector' => 'consumer_selector',
        'take' => 1,
        'from' => 'from',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.rate_limit_policies.list(
    resource="oauth_authentication_api",
    consumer="client",
    consumer_selector="consumer_selector",
    take=1,
    from="from",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.rate_limit_policies.list(
  resource: "oauth_authentication_api",
  consumer: "client",
  consumer_selector: "consumer_selector",
  take: 1,
  from: "from"
)

curl --request GET \
  --url https://{tenantDomain}/api/v2/rate-limit-policies \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/rate-limit-policies', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/rate-limit-policies"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

200

{
  "rate_limit_policies": [
    {
      "id": "<string>",
      "resource": "oauth_authentication_api",
      "consumer": "client",
      "consumer_selector": "<string>",
      "configuration": {
        "action": "allow"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

resource · enum<string>

The API protected by the Rate Limit Policy.

Available options: oauth_authentication_api

consumer · enum<string>

The consumer to which the rate limit policy applies.

Available options: client

consumer_selector · string

Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id> to target a specific client by ID, client_id:<cimd_uri> to target a CIMD client by URI, cimd_clients to target all CIMD clients, third_party_clients to target all third-party clients, or default to apply the policy to any consumer identifier not otherwise explicitly targeted.

Maximum string length: 255

take · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

from · string

Cursor for pagination.

Maximum string length: 1000

Response

200

application/json

Rate limit policies retrieved successfully.

rate_limit_policies · object[]

Show child attributes

next · string

A cursor to be used as the "from" query parameter for the next page of results.