1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. RateLimiting
Viewing docs for Okta v6.6.0
published on Wednesday, Apr 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.RateLimiting

okta logo
Viewing docs for Okta v6.6.0
published on Wednesday, Apr 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Manages per-client rate limiting settings for your Okta organization.

    This resource configures how Okta handles rate limiting on a per-client basis, allowing you to set a default mode and override settings for specific use cases.

    Example Usage

    Basic Usage

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

const example = new okta.RateLimiting("example", {defaultMode: "ENFORCE"});

    import pulumi
import pulumi_okta as okta

example = okta.RateLimiting("example", default_mode="ENFORCE")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewRateLimiting(ctx, "example", &okta.RateLimitingArgs{
			DefaultMode: pulumi.String("ENFORCE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Okta.Index.RateLimiting("example", new()
    {
        DefaultMode = "ENFORCE",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.RateLimiting;
import com.pulumi.okta.RateLimitingArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        var example = new RateLimiting("example", RateLimitingArgs.builder()
            .defaultMode("ENFORCE")
            .build());

    }
}

    resources:
  example:
    type: okta:RateLimiting
    properties:
      defaultMode: ENFORCE

    With Use Case Overrides

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

const example = new okta.RateLimiting("example", {
    defaultMode: "ENFORCE",
    useCaseModeOverrides: {
        loginPage: "PREVIEW",
        oauth2Authorize: "ENFORCE",
        oieAppIntent: "DISABLE",
    },
});

    import pulumi
import pulumi_okta as okta

example = okta.RateLimiting("example",
    default_mode="ENFORCE",
    use_case_mode_overrides={
        "login_page": "PREVIEW",
        "oauth2_authorize": "ENFORCE",
        "oie_app_intent": "DISABLE",
    })

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.NewRateLimiting(ctx, "example", &okta.RateLimitingArgs{
			DefaultMode: pulumi.String("ENFORCE"),
			UseCaseModeOverrides: &okta.RateLimitingUseCaseModeOverridesArgs{
				LoginPage:       pulumi.String("PREVIEW"),
				Oauth2Authorize: pulumi.String("ENFORCE"),
				OieAppIntent:    pulumi.String("DISABLE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Okta.Index.RateLimiting("example", new()
    {
        DefaultMode = "ENFORCE",
        UseCaseModeOverrides = new Okta.Inputs.RateLimitingUseCaseModeOverridesArgs
        {
            LoginPage = "PREVIEW",
            Oauth2Authorize = "ENFORCE",
            OieAppIntent = "DISABLE",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.RateLimiting;
import com.pulumi.okta.RateLimitingArgs;
import com.pulumi.okta.inputs.RateLimitingUseCaseModeOverridesArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        var example = new RateLimiting("example", RateLimitingArgs.builder()
            .defaultMode("ENFORCE")
            .useCaseModeOverrides(RateLimitingUseCaseModeOverridesArgs.builder()
                .loginPage("PREVIEW")
                .oauth2Authorize("ENFORCE")
                .oieAppIntent("DISABLE")
                .build())
            .build());

    }
}

    resources:
  example:
    type: okta:RateLimiting
    properties:
      defaultMode: ENFORCE
      useCaseModeOverrides:
        loginPage: PREVIEW
        oauth2Authorize: ENFORCE
        oieAppIntent: DISABLE

    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

    LoginPage string
    Rate limit mode for the Okta hosted login page. Valid values: ENFORCE, DISABLE, PREVIEW.
    Oauth2Authorize string
    Rate limit mode for OAuth2 authorization requests. Valid values: ENFORCE, DISABLE, PREVIEW.
    OieAppIntent string
    Rate limit mode for OIE app intent. Valid values: ENFORCE, DISABLE, PREVIEW.
    LoginPage string
    Rate limit mode for the Okta hosted login page. Valid values: ENFORCE, DISABLE, PREVIEW.
    Oauth2Authorize string
    Rate limit mode for OAuth2 authorization requests. Valid values: ENFORCE, DISABLE, PREVIEW.
    OieAppIntent string
    Rate limit mode for OIE app intent. Valid values: ENFORCE, DISABLE, PREVIEW.
    loginPage String
    Rate limit mode for the Okta hosted login page. Valid values: ENFORCE, DISABLE, PREVIEW.
    oauth2Authorize String
    Rate limit mode for OAuth2 authorization requests. Valid values: ENFORCE, DISABLE, PREVIEW.
    oieAppIntent String
    Rate limit mode for OIE app intent. Valid values: ENFORCE, DISABLE, PREVIEW.
    loginPage string
    Rate limit mode for the Okta hosted login page. Valid values: ENFORCE, DISABLE, PREVIEW.
    oauth2Authorize string
    Rate limit mode for OAuth2 authorization requests. Valid values: ENFORCE, DISABLE, PREVIEW.
    oieAppIntent string
    Rate limit mode for OIE app intent. Valid values: ENFORCE, DISABLE, PREVIEW.
    login_page str
    Rate limit mode for the Okta hosted login page. Valid values: ENFORCE, DISABLE, PREVIEW.
    oauth2_authorize str
    Rate limit mode for OAuth2 authorization requests. Valid values: ENFORCE, DISABLE, PREVIEW.
    oie_app_intent str
    Rate limit mode for OIE app intent. Valid values: ENFORCE, DISABLE, PREVIEW.
    loginPage String
    Rate limit mode for the Okta hosted login page. Valid values: ENFORCE, DISABLE, PREVIEW.
    oauth2Authorize String
    Rate limit mode for OAuth2 authorization requests. Valid values: ENFORCE, DISABLE, PREVIEW.
    oieAppIntent String
    Rate limit mode for OIE app intent. Valid values: ENFORCE, DISABLE, PREVIEW.

    Import

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

    Note: The import ID is a literal dot (.) since there is only one rate limiting configuration per Okta organization.

    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
    Viewing docs for Okta v6.6.0
    published on Wednesday, Apr 29, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-okta
      Try Pulumi Cloud free. Your team will thank you.