1. Packages
  2. Okta Provider
  3. API Docs
  4. RateLimiting
Okta v6.0.0 published on Friday, Oct 10, 2025 by Pulumi
pulumi/pulumi-okta

okta.RateLimiting

Get Started
okta logo
Okta v6.0.0 published on Friday, Oct 10, 2025 by Pulumi
pulumi/pulumi-okta

    Manages rate limiting. This resource allows you to configure the client-based rate limit and rate limiting communications settings.

    WARNING: This resource is deprecated and will be removed in a future release. A new resource to manage rate limiting settings will be implemented in the future.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  example:
    type: okta:RateLimiting
    properties:
      login: ENFORCE
      authorize: ENFORCE
      communicationsEnabled: true

    Create RateLimiting Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RateLimiting(name: string, args: RateLimitingArgs, opts?: CustomResourceOptions);
    @overload
def RateLimiting(resource_name: str,
                 args: RateLimitingArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def RateLimiting(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 default_mode: Optional[str] = None,
                 use_case_mode_overrides: Optional[RateLimitingUseCaseModeOverridesArgs] = None)
    func NewRateLimiting(ctx *Context, name string, args RateLimitingArgs, opts ...ResourceOption) (*RateLimiting, error)
    public RateLimiting(string name, RateLimitingArgs args, CustomResourceOptions? opts = null)
    public RateLimiting(String name, RateLimitingArgs args)
public RateLimiting(String name, RateLimitingArgs args, CustomResourceOptions options)

    type: okta:RateLimiting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RateLimitingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RateLimitingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RateLimitingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RateLimitingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RateLimitingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var rateLimitingResource = new Okta.RateLimiting("rateLimitingResource", new()
{
    DefaultMode = "string",
    UseCaseModeOverrides = new Okta.Inputs.RateLimitingUseCaseModeOverridesArgs
    {
        LoginPage = "string",
        Oauth2Authorize = "string",
        OieAppIntent = "string",
    },
});

    example, err := okta.NewRateLimiting(ctx, "rateLimitingResource", &okta.RateLimitingArgs{
	DefaultMode: pulumi.String("string"),
	UseCaseModeOverrides: &okta.RateLimitingUseCaseModeOverridesArgs{
		LoginPage:       pulumi.String("string"),
		Oauth2Authorize: pulumi.String("string"),
		OieAppIntent:    pulumi.String("string"),
	},
})

    var rateLimitingResource = new RateLimiting("rateLimitingResource", RateLimitingArgs.builder()
    .defaultMode("string")
    .useCaseModeOverrides(RateLimitingUseCaseModeOverridesArgs.builder()
        .loginPage("string")
        .oauth2Authorize("string")
        .oieAppIntent("string")
        .build())
    .build());

    rate_limiting_resource = okta.RateLimiting("rateLimitingResource",
    default_mode="string",
    use_case_mode_overrides={
        "login_page": "string",
        "oauth2_authorize": "string",
        "oie_app_intent": "string",
    })

    const rateLimitingResource = new okta.RateLimiting("rateLimitingResource", {
    defaultMode: "string",
    useCaseModeOverrides: {
        loginPage: "string",
        oauth2Authorize: "string",
        oieAppIntent: "string",
    },
});

    type: okta:RateLimiting
properties:
    defaultMode: string
    useCaseModeOverrides:
        loginPage: string
        oauth2Authorize: string
        oieAppIntent: string

    RateLimiting Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RateLimiting resource accepts the following input properties:

    DefaultMode string
    UseCaseModeOverrides RateLimitingUseCaseModeOverrides
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    DefaultMode string
    UseCaseModeOverrides RateLimitingUseCaseModeOverridesArgs
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    defaultMode String
    useCaseModeOverrides RateLimitingUseCaseModeOverrides
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    defaultMode string
    useCaseModeOverrides RateLimitingUseCaseModeOverrides
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    default_mode str
    use_case_mode_overrides RateLimitingUseCaseModeOverridesArgs
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    defaultMode String
    useCaseModeOverrides Property Map
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RateLimiting resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RateLimiting Resource

    Get an existing RateLimiting resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RateLimitingState, opts?: CustomResourceOptions): RateLimiting
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_mode: Optional[str] = None,
        use_case_mode_overrides: Optional[RateLimitingUseCaseModeOverridesArgs] = None) -> RateLimiting
    func GetRateLimiting(ctx *Context, name string, id IDInput, state *RateLimitingState, opts ...ResourceOption) (*RateLimiting, error)
    public static RateLimiting Get(string name, Input<string> id, RateLimitingState? state, CustomResourceOptions? opts = null)
    public static RateLimiting get(String name, Output<String> id, RateLimitingState state, CustomResourceOptions options)
    resources:  _:    type: okta:RateLimiting    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefaultMode string
    UseCaseModeOverrides RateLimitingUseCaseModeOverrides
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    DefaultMode string
    UseCaseModeOverrides RateLimitingUseCaseModeOverridesArgs
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    defaultMode String
    useCaseModeOverrides RateLimitingUseCaseModeOverrides
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    defaultMode string
    useCaseModeOverrides RateLimitingUseCaseModeOverrides
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    default_mode str
    use_case_mode_overrides RateLimitingUseCaseModeOverridesArgs
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.
    defaultMode String
    useCaseModeOverrides Property Map
    A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode.Overrides the defaultMode property for the specified use cases.

    Supporting Types

    RateLimitingUseCaseModeOverrides, RateLimitingUseCaseModeOverridesArgs

    Import

    $ pulumi import okta:index/rateLimiting:RateLimiting example .

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v6.0.0 published on Friday, Oct 10, 2025 by Pulumi
    pulumi/pulumi-okta
      Meet Neo: Your AI Platform Teammate