Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. getRateLimitPolicy
Viewing docs for Auth0 v3.50.1
published on Saturday, Aug 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

auth0.getRateLimitPolicy

auth0 logo auth0 logo
Viewing docs for Auth0 v3.50.1
published on Saturday, Aug 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-auth0

    Data source to retrieve a single Rate Limit Policy by ID. (EA only)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

const example = auth0.getRateLimitPolicy({
    policyId: "rlp_XXXXXXXXXXXXXXXX",
});

    import pulumi
import pulumi_auth0 as auth0

example = auth0.get_rate_limit_policy(policy_id="rlp_XXXXXXXXXXXXXXXX")

    package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := auth0.GetRateLimitPolicy(ctx, &auth0.LookupRateLimitPolicyArgs{
			PolicyId: "rlp_XXXXXXXXXXXXXXXX",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    var example = Auth0.GetRateLimitPolicy.Invoke(new()
    {
        PolicyId = "rlp_XXXXXXXXXXXXXXXX",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.Auth0Functions;
import com.pulumi.auth0.inputs.GetRateLimitPolicyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = Auth0Functions.getRateLimitPolicy(GetRateLimitPolicyArgs.builder()
            .policyId("rlp_XXXXXXXXXXXXXXXX")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: auth0:getRateLimitPolicy
      arguments:
        policyId: rlp_XXXXXXXXXXXXXXXX

    pulumi {
  required_providers {
    auth0 = {
      source = "pulumi/auth0"
    }
  }
}

data "auth0_getratelimitpolicy" "example" {
  policy_id = "rlp_XXXXXXXXXXXXXXXX"
}

    Using getRateLimitPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRateLimitPolicy(args: GetRateLimitPolicyArgs, opts?: InvokeOptions): Promise<GetRateLimitPolicyResult>
function getRateLimitPolicyOutput(args: GetRateLimitPolicyOutputArgs, opts?: InvokeOptions): Output<GetRateLimitPolicyResult>
    def get_rate_limit_policy(policy_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRateLimitPolicyResult
def get_rate_limit_policy_output(policy_id: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRateLimitPolicyResult]
    func LookupRateLimitPolicy(ctx *Context, args *LookupRateLimitPolicyArgs, opts ...InvokeOption) (*LookupRateLimitPolicyResult, error)
func LookupRateLimitPolicyOutput(ctx *Context, args *LookupRateLimitPolicyOutputArgs, opts ...InvokeOption) LookupRateLimitPolicyResultOutput

    > Note: This function is named LookupRateLimitPolicy in the Go SDK.

    public static class GetRateLimitPolicy 
{
    public static Task<GetRateLimitPolicyResult> InvokeAsync(GetRateLimitPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetRateLimitPolicyResult> Invoke(GetRateLimitPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRateLimitPolicyResult> getRateLimitPolicy(GetRateLimitPolicyArgs args, InvokeOptions options)
public static Output<GetRateLimitPolicyResult> getRateLimitPolicy(GetRateLimitPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: auth0:index/getRateLimitPolicy:getRateLimitPolicy
  arguments:
    # arguments dictionary
    data "auth0_get_rate_limit_policy" "name" {
    # arguments
}

    The following arguments are supported:

    PolicyId string
    The ID of the Rate Limit Policy. (EA only)
    PolicyId string
    The ID of the Rate Limit Policy. (EA only)
    policy_id string
    The ID of the Rate Limit Policy. (EA only)
    policyId String
    The ID of the Rate Limit Policy. (EA only)
    policyId string
    The ID of the Rate Limit Policy. (EA only)
    policy_id str
    The ID of the Rate Limit Policy. (EA only)
    policyId String
    The ID of the Rate Limit Policy. (EA only)

    getRateLimitPolicy Result

    The following output properties are available:

    Configurations List<GetRateLimitPolicyConfiguration>
    The throttling configuration applied when the rate limit is reached. (EA only)
    Consumer string
    The consumer category the policy applies to. Valid values are: client
    ConsumerSelector string
    Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id>, client_id:<cimd_uri>, cimdClients, thirdPartyClients, or default. (EA only)
    CreatedAt string
    The date and time when the rate limit policy was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    The ID of the Rate Limit Policy. (EA only)
    Resource string
    The resource the policy applies to. Valid values are: oauthauthenticationapi
    UpdatedAt string
    The date and time when the rate limit policy was last updated.
    Configurations []GetRateLimitPolicyConfiguration
    The throttling configuration applied when the rate limit is reached. (EA only)
    Consumer string
    The consumer category the policy applies to. Valid values are: client
    ConsumerSelector string
    Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id>, client_id:<cimd_uri>, cimdClients, thirdPartyClients, or default. (EA only)
    CreatedAt string
    The date and time when the rate limit policy was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    The ID of the Rate Limit Policy. (EA only)
    Resource string
    The resource the policy applies to. Valid values are: oauthauthenticationapi
    UpdatedAt string
    The date and time when the rate limit policy was last updated.
    configurations list(object)
    The throttling configuration applied when the rate limit is reached. (EA only)
    consumer string
    The consumer category the policy applies to. Valid values are: client
    consumer_selector string
    Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id>, client_id:<cimd_uri>, cimdClients, thirdPartyClients, or default. (EA only)
    created_at string
    The date and time when the rate limit policy was created.
    id string
    The provider-assigned unique ID for this managed resource.
    policy_id string
    The ID of the Rate Limit Policy. (EA only)
    resource string
    The resource the policy applies to. Valid values are: oauthauthenticationapi
    updated_at string
    The date and time when the rate limit policy was last updated.
    configurations List<GetRateLimitPolicyConfiguration>
    The throttling configuration applied when the rate limit is reached. (EA only)
    consumer String
    The consumer category the policy applies to. Valid values are: client
    consumerSelector String
    Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id>, client_id:<cimd_uri>, cimdClients, thirdPartyClients, or default. (EA only)
    createdAt String
    The date and time when the rate limit policy was created.
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    The ID of the Rate Limit Policy. (EA only)
    resource String
    The resource the policy applies to. Valid values are: oauthauthenticationapi
    updatedAt String
    The date and time when the rate limit policy was last updated.
    configurations GetRateLimitPolicyConfiguration[]
    The throttling configuration applied when the rate limit is reached. (EA only)
    consumer string
    The consumer category the policy applies to. Valid values are: client
    consumerSelector string
    Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id>, client_id:<cimd_uri>, cimdClients, thirdPartyClients, or default. (EA only)
    createdAt string
    The date and time when the rate limit policy was created.
    id string
    The provider-assigned unique ID for this managed resource.
    policyId string
    The ID of the Rate Limit Policy. (EA only)
    resource string
    The resource the policy applies to. Valid values are: oauthauthenticationapi
    updatedAt string
    The date and time when the rate limit policy was last updated.
    configurations Sequence[GetRateLimitPolicyConfiguration]
    The throttling configuration applied when the rate limit is reached. (EA only)
    consumer str
    The consumer category the policy applies to. Valid values are: client
    consumer_selector str
    Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id>, client_id:<cimd_uri>, cimdClients, thirdPartyClients, or default. (EA only)
    created_at str
    The date and time when the rate limit policy was created.
    id str
    The provider-assigned unique ID for this managed resource.
    policy_id str
    The ID of the Rate Limit Policy. (EA only)
    resource str
    The resource the policy applies to. Valid values are: oauthauthenticationapi
    updated_at str
    The date and time when the rate limit policy was last updated.
    configurations List<Property Map>
    The throttling configuration applied when the rate limit is reached. (EA only)
    consumer String
    The consumer category the policy applies to. Valid values are: client
    consumerSelector String
    Identifier or category within the consumer to which the policy applies. Supported values: client_id:<client_id>, client_id:<cimd_uri>, cimdClients, thirdPartyClients, or default. (EA only)
    createdAt String
    The date and time when the rate limit policy was created.
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    The ID of the Rate Limit Policy. (EA only)
    resource String
    The resource the policy applies to. Valid values are: oauthauthenticationapi
    updatedAt String
    The date and time when the rate limit policy was last updated.

    Supporting Types

    GetRateLimitPolicyConfiguration

    Action string
    Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only)
    Limit int
    Maximum number of requests allowed in a single window (0-10000). Required and only valid for the block, log, and redirect actions. (EA only)
    RedirectUri string
    HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the redirect action. (EA only)
    Action string
    Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only)
    Limit int
    Maximum number of requests allowed in a single window (0-10000). Required and only valid for the block, log, and redirect actions. (EA only)
    RedirectUri string
    HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the redirect action. (EA only)
    action string
    Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only)
    limit number
    Maximum number of requests allowed in a single window (0-10000). Required and only valid for the block, log, and redirect actions. (EA only)
    redirect_uri string
    HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the redirect action. (EA only)
    action String
    Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only)
    limit Integer
    Maximum number of requests allowed in a single window (0-10000). Required and only valid for the block, log, and redirect actions. (EA only)
    redirectUri String
    HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the redirect action. (EA only)
    action string
    Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only)
    limit number
    Maximum number of requests allowed in a single window (0-10000). Required and only valid for the block, log, and redirect actions. (EA only)
    redirectUri string
    HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the redirect action. (EA only)
    action str
    Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only)
    limit int
    Maximum number of requests allowed in a single window (0-10000). Required and only valid for the block, log, and redirect actions. (EA only)
    redirect_uri str
    HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the redirect action. (EA only)
    action String
    Action to take when the rate limit is exceeded. Valid values are: [allow block log redirect] (EA only)
    limit Number
    Maximum number of requests allowed in a single window (0-10000). Required and only valid for the block, log, and redirect actions. (EA only)
    redirectUri String
    HTTPS URI to redirect to when the rate limit is exceeded. Required and only valid for the redirect action. (EA only)

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo auth0 logo
    Viewing docs for Auth0 v3.50.1
    published on Saturday, Aug 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-auth0

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial