レート制限ポリシーを作成

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.CreateAsync(
            new CreateRateLimitPolicyRequestContent {
                Resource = RateLimitPolicyResourceEnum.OauthAuthenticationApi,
                Consumer = RateLimitPolicyConsumerEnum.Client,
                ConsumerSelector = "consumer_selector",
                Configuration = new RateLimitPolicyConfigurationZero {
                    Action = RateLimitPolicyConfigurationZeroAction.Allow
                }
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateRateLimitPolicyRequestContent;
import com.auth0.client.mgmt.types.RateLimitPolicyConfiguration;
import com.auth0.client.mgmt.types.RateLimitPolicyConfigurationZero;
import com.auth0.client.mgmt.types.RateLimitPolicyConfigurationZeroAction;
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().create(
            CreateRateLimitPolicyRequestContent
                .builder()
                .resource(RateLimitPolicyResourceEnum.OAUTH_AUTHENTICATION_API)
                .consumer(RateLimitPolicyConsumerEnum.CLIENT)
                .consumerSelector("consumer_selector")
                .configuration(
                    RateLimitPolicyConfiguration.of(
                        RateLimitPolicyConfigurationZero
                            .builder()
                            .action(RateLimitPolicyConfigurationZeroAction.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\CreateRateLimitPolicyRequestContent;
use Auth0\SDK\API\Management\Types\RateLimitPolicyResourceEnum;
use Auth0\SDK\API\Management\Types\RateLimitPolicyConsumerEnum;
use Auth0\SDK\API\Management\Types\RateLimitPolicyConfigurationZero;
use Auth0\SDK\API\Management\Types\RateLimitPolicyConfigurationZeroAction;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rateLimitPolicies->create(
    new CreateRateLimitPolicyRequestContent([
        'resource' => RateLimitPolicyResourceEnum::OauthAuthenticationApi->value,
        'consumer' => RateLimitPolicyConsumerEnum::Client->value,
        'consumerSelector' => 'consumer_selector',
        'configuration' => new RateLimitPolicyConfigurationZero([
            'action' => RateLimitPolicyConfigurationZeroAction::Allow->value,
        ]),
    ]),
);

from auth0.management import ManagementClient, RateLimitPolicyConfigurationZero

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

client.rate_limit_policies.create(
    resource="oauth_authentication_api",
    consumer="client",
    consumer_selector="consumer_selector",
    configuration=RateLimitPolicyConfigurationZero(
        action="allow",
    ),
)

require "auth0"

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

client.rate_limit_policies.create(
  resource: "oauth_authentication_api",
  consumer: "client",
  consumer_selector: "consumer_selector",
  configuration: {
    action: "allow"
  }
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/rate-limit-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {
    "action": "allow"
  },
  "consumer": "client",
  "consumer_selector": "<string>",
  "resource": "oauth_authentication_api"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    configuration: {action: 'allow'},
    consumer: 'client',
    consumer_selector: '<string>',
    resource: 'oauth_authentication_api'
  })
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"configuration\": {\n    \"action\": \"allow\"\n  },\n  \"consumer\": \"client\",\n  \"consumer_selector\": \"<string>\",\n  \"resource\": \"oauth_authentication_api\"\n}")

	req, _ := http.NewRequest("POST", 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))

}

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

POST

https://{tenantDomain}/api/v2

rate-limit-policies

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.CreateAsync(
            new CreateRateLimitPolicyRequestContent {
                Resource = RateLimitPolicyResourceEnum.OauthAuthenticationApi,
                Consumer = RateLimitPolicyConsumerEnum.Client,
                ConsumerSelector = "consumer_selector",
                Configuration = new RateLimitPolicyConfigurationZero {
                    Action = RateLimitPolicyConfigurationZeroAction.Allow
                }
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateRateLimitPolicyRequestContent;
import com.auth0.client.mgmt.types.RateLimitPolicyConfiguration;
import com.auth0.client.mgmt.types.RateLimitPolicyConfigurationZero;
import com.auth0.client.mgmt.types.RateLimitPolicyConfigurationZeroAction;
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().create(
            CreateRateLimitPolicyRequestContent
                .builder()
                .resource(RateLimitPolicyResourceEnum.OAUTH_AUTHENTICATION_API)
                .consumer(RateLimitPolicyConsumerEnum.CLIENT)
                .consumerSelector("consumer_selector")
                .configuration(
                    RateLimitPolicyConfiguration.of(
                        RateLimitPolicyConfigurationZero
                            .builder()
                            .action(RateLimitPolicyConfigurationZeroAction.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\CreateRateLimitPolicyRequestContent;
use Auth0\SDK\API\Management\Types\RateLimitPolicyResourceEnum;
use Auth0\SDK\API\Management\Types\RateLimitPolicyConsumerEnum;
use Auth0\SDK\API\Management\Types\RateLimitPolicyConfigurationZero;
use Auth0\SDK\API\Management\Types\RateLimitPolicyConfigurationZeroAction;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->rateLimitPolicies->create(
    new CreateRateLimitPolicyRequestContent([
        'resource' => RateLimitPolicyResourceEnum::OauthAuthenticationApi->value,
        'consumer' => RateLimitPolicyConsumerEnum::Client->value,
        'consumerSelector' => 'consumer_selector',
        'configuration' => new RateLimitPolicyConfigurationZero([
            'action' => RateLimitPolicyConfigurationZeroAction::Allow->value,
        ]),
    ]),
);

from auth0.management import ManagementClient, RateLimitPolicyConfigurationZero

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

client.rate_limit_policies.create(
    resource="oauth_authentication_api",
    consumer="client",
    consumer_selector="consumer_selector",
    configuration=RateLimitPolicyConfigurationZero(
        action="allow",
    ),
)

require "auth0"

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

client.rate_limit_policies.create(
  resource: "oauth_authentication_api",
  consumer: "client",
  consumer_selector: "consumer_selector",
  configuration: {
    action: "allow"
  }
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/rate-limit-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configuration": {
    "action": "allow"
  },
  "consumer": "client",
  "consumer_selector": "<string>",
  "resource": "oauth_authentication_api"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    configuration: {action: 'allow'},
    consumer: 'client',
    consumer_selector: '<string>',
    resource: 'oauth_authentication_api'
  })
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"configuration\": {\n    \"action\": \"allow\"\n  },\n  \"consumer\": \"client\",\n  \"consumer_selector\": \"<string>\",\n  \"resource\": \"oauth_authentication_api\"\n}")

	req, _ := http.NewRequest("POST", 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))

}

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

承認

Authorization

string

header

必須

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

ボディ

configuration

object

必須

rate limit policy の設定。

Option 1
Option 2
Option 3

Show child attributes

consumer

enum<string>

必須

rate limit policy が適用される consumer。

利用可能なオプション:

client

consumer_selector

string

必須

policyが適用されるconsumer内の識別子またはカテゴリ。サポート対象の値: IDで特定のクライアントを対象にする client_id:<client_id>、URIでCIMDクライアントを対象にする client_id:<cimd_uri>、すべてのCIMDクライアントを対象にする cimd_clients、すべてのサードパーティクライアントを対象にする third_party_clients、または明示的に対象指定されていないconsumer identifierにpolicyを適用する default。

Maximum string length: 255

resource

enum<string>

必須

Rate Limit Policy によって保護される API。

利用可能なオプション:

oauth_authentication_api

レスポンス

レート制限ポリシーが正常に作成されました。

configuration

object

必須

rate limit policy の設定。

Option 1
Option 2
Option 3

Show child attributes

consumer

enum<string>

必須

rate limit policy が適用される consumer。

利用可能なオプション:

client

consumer_selector

string

必須

Maximum string length: 255

string<rate-limit-policy-id>

必須

Rate Limit Policyの一意の識別子。

Maximum string length: 26

resource

enum<string>

必須

Rate Limit Policy によって保護される API。

利用可能なオプション:

oauth_authentication_api

created_at

string<date-time>

rate limit policyが作成された日時。

updated_at

string<date-time>

rate limit policyが最後に更新された日時。