Update a rate limit policy

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.UpdateAsync(
            id: "id",
            request: new PatchRateLimitPolicyRequestContent {
                Configuration = new PatchRateLimitPolicyConfigurationRequestContentZero {
                    Action = PatchRateLimitPolicyConfigurationRequestContentZeroAction.Allow
                }
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyConfigurationRequestContent;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyConfigurationRequestContentZero;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyConfigurationRequestContentZeroAction;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyRequestContent;

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

        client.rateLimitPolicies().update(
            "id",
            PatchRateLimitPolicyRequestContent
                .builder()
                .configuration(
                    PatchRateLimitPolicyConfigurationRequestContent.of(
                        PatchRateLimitPolicyConfigurationRequestContentZero
                            .builder()
                            .action(PatchRateLimitPolicyConfigurationRequestContentZeroAction.ALLOW)
                            .build()
                    )
                )
                .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\PatchRateLimitPolicyRequestContent;
use Auth0\SDK\API\Management\Types\PatchRateLimitPolicyConfigurationRequestContentZero;
use Auth0\SDK\API\Management\Types\PatchRateLimitPolicyConfigurationRequestContentZeroAction;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rateLimitPolicies->update(
    'id',
    new PatchRateLimitPolicyRequestContent([
        'configuration' => new PatchRateLimitPolicyConfigurationRequestContentZero([
            'action' => PatchRateLimitPolicyConfigurationRequestContentZeroAction::Allow->value,
        ]),
    ]),
);

from auth0.management import ManagementClient, PatchRateLimitPolicyConfigurationRequestContentZero

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

client.rate_limit_policies.update(
    id="id",
    configuration=PatchRateLimitPolicyConfigurationRequestContentZero(
        action="allow",
    ),
)

require "auth0"

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

client.rate_limit_policies.update(
  id: "id",
  configuration: {
    action: "allow"
  }
)

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/rate-limit-policies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {
    "action": "allow"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({configuration: {action: 'allow'}})
};

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"configuration\": {\n    \"action\": \"allow\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "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"
}

PATCH

https://{tenantDomain}/api/v2

rate-limit-policies

{id}

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.UpdateAsync(
            id: "id",
            request: new PatchRateLimitPolicyRequestContent {
                Configuration = new PatchRateLimitPolicyConfigurationRequestContentZero {
                    Action = PatchRateLimitPolicyConfigurationRequestContentZeroAction.Allow
                }
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyConfigurationRequestContent;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyConfigurationRequestContentZero;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyConfigurationRequestContentZeroAction;
import com.auth0.client.mgmt.types.PatchRateLimitPolicyRequestContent;

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

        client.rateLimitPolicies().update(
            "id",
            PatchRateLimitPolicyRequestContent
                .builder()
                .configuration(
                    PatchRateLimitPolicyConfigurationRequestContent.of(
                        PatchRateLimitPolicyConfigurationRequestContentZero
                            .builder()
                            .action(PatchRateLimitPolicyConfigurationRequestContentZeroAction.ALLOW)
                            .build()
                    )
                )
                .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\PatchRateLimitPolicyRequestContent;
use Auth0\SDK\API\Management\Types\PatchRateLimitPolicyConfigurationRequestContentZero;
use Auth0\SDK\API\Management\Types\PatchRateLimitPolicyConfigurationRequestContentZeroAction;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rateLimitPolicies->update(
    'id',
    new PatchRateLimitPolicyRequestContent([
        'configuration' => new PatchRateLimitPolicyConfigurationRequestContentZero([
            'action' => PatchRateLimitPolicyConfigurationRequestContentZeroAction::Allow->value,
        ]),
    ]),
);

from auth0.management import ManagementClient, PatchRateLimitPolicyConfigurationRequestContentZero

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

client.rate_limit_policies.update(
    id="id",
    configuration=PatchRateLimitPolicyConfigurationRequestContentZero(
        action="allow",
    ),
)

require "auth0"

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

client.rate_limit_policies.update(
  id: "id",
  configuration: {
    action: "allow"
  }
)

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/rate-limit-policies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {
    "action": "allow"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({configuration: {action: 'allow'}})
};

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"configuration\": {\n    \"action\": \"allow\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "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"
}

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

string

requis

Unique identifier for the Rate Limit Policy.

Maximum string length: 26

Corps

configuration

object

requis

Option 1
Option 2
Option 3

Show child attributes

Réponse

Rate limit policy successfully updated.

string<rate-limit-policy-id>

requis

Unique identifier for the Rate Limit Policy.

Maximum string length: 26

resource

enum<string>

requis

The API protected by the Rate Limit Policy.

Options disponibles:

oauth_authentication_api

consumer

enum<string>

requis

The consumer to which the rate limit policy applies.

Options disponibles:

client

consumer_selector

string

requis

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

configuration

object

requis

The configuration of the rate limit policy.

Option 1
Option 2
Option 3

Show child attributes

created_at

string<date-time>

The date and time when the rate limit policy was created.

updated_at

string<date-time>

The date and time when the rate limit policy was last updated.

Delete a rate limit policy

Get refresh tokens

⌘I