1. Packages
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. getRateLimitPolicies
Viewing docs for Auth0 v3.49.0
published on Tuesday, Jul 21, 2026 by Pulumi
auth0 logo
Viewing docs for Auth0 v3.49.0
published on Tuesday, Jul 21, 2026 by Pulumi

    Data source to retrieve Rate Limit Policies, optionally filtered by resource, consumer, or consumer selector. (EA only)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    const filtered = auth0.getRateLimitPolicies({
        resource: "oauth_authentication_api",
        consumer: "client",
        consumerSelector: "default",
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    filtered = auth0.get_rate_limit_policies(resource="oauth_authentication_api",
        consumer="client",
        consumer_selector="default")
    
    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.GetRateLimitPolicies(ctx, &auth0.GetRateLimitPoliciesArgs{
    			Resource:         pulumi.StringRef("oauth_authentication_api"),
    			Consumer:         pulumi.StringRef("client"),
    			ConsumerSelector: pulumi.StringRef("default"),
    		}, 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 filtered = Auth0.GetRateLimitPolicies.Invoke(new()
        {
            Resource = "oauth_authentication_api",
            Consumer = "client",
            ConsumerSelector = "default",
        });
    
    });
    
    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.GetRateLimitPoliciesArgs;
    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 filtered = Auth0Functions.getRateLimitPolicies(GetRateLimitPoliciesArgs.builder()
                .resource("oauth_authentication_api")
                .consumer("client")
                .consumerSelector("default")
                .build());
    
        }
    }
    
    variables:
      filtered:
        fn::invoke:
          function: auth0:getRateLimitPolicies
          arguments:
            resource: oauth_authentication_api
            consumer: client
            consumerSelector: default
    
    pulumi {
      required_providers {
        auth0 = {
          source = "pulumi/auth0"
        }
      }
    }
    
    data "auth0_getratelimitpolicies" "filtered" {
      resource          = "oauth_authentication_api"
      consumer          = "client"
      consumer_selector = "default"
    }
    

    Using getRateLimitPolicies

    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 getRateLimitPolicies(args: GetRateLimitPoliciesArgs, opts?: InvokeOptions): Promise<GetRateLimitPoliciesResult>
    function getRateLimitPoliciesOutput(args: GetRateLimitPoliciesOutputArgs, opts?: InvokeOptions): Output<GetRateLimitPoliciesResult>
    def get_rate_limit_policies(consumer: Optional[str] = None,
                                consumer_selector: Optional[str] = None,
                                resource: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetRateLimitPoliciesResult
    def get_rate_limit_policies_output(consumer: pulumi.Input[Optional[str]] = None,
                                consumer_selector: pulumi.Input[Optional[str]] = None,
                                resource: pulumi.Input[Optional[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetRateLimitPoliciesResult]
    func GetRateLimitPolicies(ctx *Context, args *GetRateLimitPoliciesArgs, opts ...InvokeOption) (*GetRateLimitPoliciesResult, error)
    func GetRateLimitPoliciesOutput(ctx *Context, args *GetRateLimitPoliciesOutputArgs, opts ...InvokeOption) GetRateLimitPoliciesResultOutput

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

    public static class GetRateLimitPolicies 
    {
        public static Task<GetRateLimitPoliciesResult> InvokeAsync(GetRateLimitPoliciesArgs args, InvokeOptions? opts = null)
        public static Output<GetRateLimitPoliciesResult> Invoke(GetRateLimitPoliciesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRateLimitPoliciesResult> getRateLimitPolicies(GetRateLimitPoliciesArgs args, InvokeOptions options)
    public static Output<GetRateLimitPoliciesResult> getRateLimitPolicies(GetRateLimitPoliciesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: auth0:index/getRateLimitPolicies:getRateLimitPolicies
      arguments:
        # arguments dictionary
    data "auth0_get_rate_limit_policies" "name" {
        # arguments
    }

    The following arguments are supported:

    Consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    ConsumerSelector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    Resource string
    Filter policies by resource. (EA only)
    Consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    ConsumerSelector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    Resource string
    Filter policies by resource. (EA only)
    consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumer_selector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource string
    Filter policies by resource. (EA only)
    consumer String
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumerSelector String
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource String
    Filter policies by resource. (EA only)
    consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumerSelector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource string
    Filter policies by resource. (EA only)
    consumer str
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumer_selector str
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource str
    Filter policies by resource. (EA only)
    consumer String
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumerSelector String
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource String
    Filter policies by resource. (EA only)

    getRateLimitPolicies Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    RateLimitPolicies List<GetRateLimitPoliciesRateLimitPolicy>
    List of Rate Limit Policies matching the filter criteria. (EA only)
    Consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    ConsumerSelector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    Resource string
    Filter policies by resource. (EA only)
    Id string
    The provider-assigned unique ID for this managed resource.
    RateLimitPolicies []GetRateLimitPoliciesRateLimitPolicy
    List of Rate Limit Policies matching the filter criteria. (EA only)
    Consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    ConsumerSelector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    Resource string
    Filter policies by resource. (EA only)
    id string
    The provider-assigned unique ID for this managed resource.
    rate_limit_policies list(object)
    List of Rate Limit Policies matching the filter criteria. (EA only)
    consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumer_selector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource string
    Filter policies by resource. (EA only)
    id String
    The provider-assigned unique ID for this managed resource.
    rateLimitPolicies List<GetRateLimitPoliciesRateLimitPolicy>
    List of Rate Limit Policies matching the filter criteria. (EA only)
    consumer String
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumerSelector String
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource String
    Filter policies by resource. (EA only)
    id string
    The provider-assigned unique ID for this managed resource.
    rateLimitPolicies GetRateLimitPoliciesRateLimitPolicy[]
    List of Rate Limit Policies matching the filter criteria. (EA only)
    consumer string
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumerSelector string
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource string
    Filter policies by resource. (EA only)
    id str
    The provider-assigned unique ID for this managed resource.
    rate_limit_policies Sequence[GetRateLimitPoliciesRateLimitPolicy]
    List of Rate Limit Policies matching the filter criteria. (EA only)
    consumer str
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumer_selector str
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource str
    Filter policies by resource. (EA only)
    id String
    The provider-assigned unique ID for this managed resource.
    rateLimitPolicies List<Property Map>
    List of Rate Limit Policies matching the filter criteria. (EA only)
    consumer String
    Filter policies by consumer. Requires resource to also be set. (EA only)
    consumerSelector String
    Filter policies by consumer selector. Requires consumer to also be set. (EA only)
    resource String
    Filter policies by resource. (EA only)

    Supporting Types

    GetRateLimitPoliciesRateLimitPolicy

    Configurations List<GetRateLimitPoliciesRateLimitPolicyConfiguration>
    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] (EA Only)
    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 ID of the Rate Limit Policy. (EA only)
    Resource string
    The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only)
    UpdatedAt string
    The date and time when the rate limit policy was last updated.
    Configurations []GetRateLimitPoliciesRateLimitPolicyConfiguration
    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] (EA Only)
    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 ID of the Rate Limit Policy. (EA only)
    Resource string
    The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only)
    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] (EA Only)
    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 ID of the Rate Limit Policy. (EA only)
    resource string
    The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only)
    updated_at string
    The date and time when the rate limit policy was last updated.
    configurations List<GetRateLimitPoliciesRateLimitPolicyConfiguration>
    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] (EA Only)
    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 ID of the Rate Limit Policy. (EA only)
    resource String
    The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only)
    updatedAt String
    The date and time when the rate limit policy was last updated.
    configurations GetRateLimitPoliciesRateLimitPolicyConfiguration[]
    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] (EA Only)
    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 ID of the Rate Limit Policy. (EA only)
    resource string
    The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only)
    updatedAt string
    The date and time when the rate limit policy was last updated.
    configurations Sequence[GetRateLimitPoliciesRateLimitPolicyConfiguration]
    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] (EA Only)
    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 ID of the Rate Limit Policy. (EA only)
    resource str
    The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only)
    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] (EA Only)
    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 ID of the Rate Limit Policy. (EA only)
    resource String
    The resource the policy applies to. Valid values are: [oauthAuthenticationApi] (EA Only)
    updatedAt String
    The date and time when the rate limit policy was last updated.

    GetRateLimitPoliciesRateLimitPolicyConfiguration

    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
    Viewing docs for Auth0 v3.49.0
    published on Tuesday, Jul 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial