Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Okta Provider
  3. API Docs
  4. RateLimiting
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta

okta.RateLimiting

Explore with Pulumi AI

Okta v4.16.0 published on Wednesday, Apr 9, 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 available only when using a SSWS API token in the provider config, it is incompatible with OAuth 2.0 authentication. WARNING: This resource makes use of an internal/private Okta API endpoint that could change without notice rendering this resource inoperable.

Example Usage

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

const example = new okta.RateLimiting("example", {
    login: "ENFORCE",
    authorize: "ENFORCE",
    communicationsEnabled: true,
});
Copy
import pulumi
import pulumi_okta as okta

example = okta.RateLimiting("example",
    login="ENFORCE",
    authorize="ENFORCE",
    communications_enabled=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v4/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{
			Login:                 pulumi.String("ENFORCE"),
			Authorize:             pulumi.String("ENFORCE"),
			CommunicationsEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = new Okta.RateLimiting("example", new()
    {
        Login = "ENFORCE",
        Authorize = "ENFORCE",
        CommunicationsEnabled = true,
    });

});
Copy
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()
            .login("ENFORCE")
            .authorize("ENFORCE")
            .communicationsEnabled(true)
            .build());

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

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,
                 authorize: Optional[str] = None,
                 login: Optional[str] = None,
                 communications_enabled: Optional[bool] = 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 This property is required. string
The unique name of the resource.
args This property is required. RateLimitingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. RateLimitingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RateLimitingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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()
{
    Authorize = "string",
    Login = "string",
    CommunicationsEnabled = false,
});
Copy
example, err := okta.NewRateLimiting(ctx, "rateLimitingResource", &okta.RateLimitingArgs{
	Authorize:             pulumi.String("string"),
	Login:                 pulumi.String("string"),
	CommunicationsEnabled: pulumi.Bool(false),
})
Copy
var rateLimitingResource = new RateLimiting("rateLimitingResource", RateLimitingArgs.builder()
    .authorize("string")
    .login("string")
    .communicationsEnabled(false)
    .build());
Copy
rate_limiting_resource = okta.RateLimiting("rateLimitingResource",
    authorize="string",
    login="string",
    communications_enabled=False)
Copy
const rateLimitingResource = new okta.RateLimiting("rateLimitingResource", {
    authorize: "string",
    login: "string",
    communicationsEnabled: false,
});
Copy
type: okta:RateLimiting
properties:
    authorize: string
    communicationsEnabled: false
    login: string
Copy

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:

Authorize This property is required. string
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
Login This property is required. string
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
CommunicationsEnabled bool
Enable or disable rate limiting communications. By default, it is true.
Authorize This property is required. string
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
Login This property is required. string
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
CommunicationsEnabled bool
Enable or disable rate limiting communications. By default, it is true.
authorize This property is required. String
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
login This property is required. String
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communicationsEnabled Boolean
Enable or disable rate limiting communications. By default, it is true.
authorize This property is required. string
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
login This property is required. string
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communicationsEnabled boolean
Enable or disable rate limiting communications. By default, it is true.
authorize This property is required. str
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
login This property is required. str
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communications_enabled bool
Enable or disable rate limiting communications. By default, it is true.
authorize This property is required. String
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
login This property is required. String
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communicationsEnabled Boolean
Enable or disable rate limiting communications. By default, it is true.

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,
        authorize: Optional[str] = None,
        communications_enabled: Optional[bool] = None,
        login: Optional[str] = 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Authorize string
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
CommunicationsEnabled bool
Enable or disable rate limiting communications. By default, it is true.
Login string
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
Authorize string
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
CommunicationsEnabled bool
Enable or disable rate limiting communications. By default, it is true.
Login string
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
authorize String
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communicationsEnabled Boolean
Enable or disable rate limiting communications. By default, it is true.
login String
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
authorize string
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communicationsEnabled boolean
Enable or disable rate limiting communications. By default, it is true.
login string
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
authorize str
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communications_enabled bool
Enable or disable rate limiting communications. By default, it is true.
login str
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
authorize String
Called during authentication. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).
communicationsEnabled Boolean
Enable or disable rate limiting communications. By default, it is true.
login String
Called when accessing the Okta hosted login page. Valid values: ENFORCE (Enforce limit and log per client (recommended)), DISABLE (Do nothing (not recommended)), PREVIEW (Log per client).

Import

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

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 v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-okta