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

okta.PrincipalRateLimits

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

    Create PrincipalRateLimits Resource

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

    Constructor syntax

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

@overload
def PrincipalRateLimits(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        principal_id: Optional[str] = None,
                        principal_type: Optional[str] = None,
                        default_concurrency_percentage: Optional[int] = None,
                        default_percentage: Optional[int] = None)
    func NewPrincipalRateLimits(ctx *Context, name string, args PrincipalRateLimitsArgs, opts ...ResourceOption) (*PrincipalRateLimits, error)
    public PrincipalRateLimits(string name, PrincipalRateLimitsArgs args, CustomResourceOptions? opts = null)
    public PrincipalRateLimits(String name, PrincipalRateLimitsArgs args)
public PrincipalRateLimits(String name, PrincipalRateLimitsArgs args, CustomResourceOptions options)

    type: okta:PrincipalRateLimits
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 PrincipalRateLimitsArgs
    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 PrincipalRateLimitsArgs
    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 PrincipalRateLimitsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrincipalRateLimitsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrincipalRateLimitsArgs
    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 principalRateLimitsResource = new Okta.PrincipalRateLimits("principalRateLimitsResource", new()
{
    PrincipalId = "string",
    PrincipalType = "string",
    DefaultConcurrencyPercentage = 0,
    DefaultPercentage = 0,
});

    example, err := okta.NewPrincipalRateLimits(ctx, "principalRateLimitsResource", &okta.PrincipalRateLimitsArgs{
	PrincipalId:                  pulumi.String("string"),
	PrincipalType:                pulumi.String("string"),
	DefaultConcurrencyPercentage: pulumi.Int(0),
	DefaultPercentage:            pulumi.Int(0),
})

    var principalRateLimitsResource = new PrincipalRateLimits("principalRateLimitsResource", PrincipalRateLimitsArgs.builder()
    .principalId("string")
    .principalType("string")
    .defaultConcurrencyPercentage(0)
    .defaultPercentage(0)
    .build());

    principal_rate_limits_resource = okta.PrincipalRateLimits("principalRateLimitsResource",
    principal_id="string",
    principal_type="string",
    default_concurrency_percentage=0,
    default_percentage=0)

    const principalRateLimitsResource = new okta.PrincipalRateLimits("principalRateLimitsResource", {
    principalId: "string",
    principalType: "string",
    defaultConcurrencyPercentage: 0,
    defaultPercentage: 0,
});

    type: okta:PrincipalRateLimits
properties:
    defaultConcurrencyPercentage: 0
    defaultPercentage: 0
    principalId: string
    principalType: string

    PrincipalRateLimits 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 PrincipalRateLimits resource accepts the following input properties:

    PrincipalId string
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    PrincipalType string
    The type of principal, either an API token or an OAuth 2.0 app.
    DefaultConcurrencyPercentage int
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    DefaultPercentage int
    The default percentage of a given rate limit threshold that the owning principal can consume.
    PrincipalId string
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    PrincipalType string
    The type of principal, either an API token or an OAuth 2.0 app.
    DefaultConcurrencyPercentage int
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    DefaultPercentage int
    The default percentage of a given rate limit threshold that the owning principal can consume.
    principalId String
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principalType String
    The type of principal, either an API token or an OAuth 2.0 app.
    defaultConcurrencyPercentage Integer
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    defaultPercentage Integer
    The default percentage of a given rate limit threshold that the owning principal can consume.
    principalId string
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principalType string
    The type of principal, either an API token or an OAuth 2.0 app.
    defaultConcurrencyPercentage number
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    defaultPercentage number
    The default percentage of a given rate limit threshold that the owning principal can consume.
    principal_id str
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principal_type str
    The type of principal, either an API token or an OAuth 2.0 app.
    default_concurrency_percentage int
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    default_percentage int
    The default percentage of a given rate limit threshold that the owning principal can consume.
    principalId String
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principalType String
    The type of principal, either an API token or an OAuth 2.0 app.
    defaultConcurrencyPercentage Number
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    defaultPercentage Number
    The default percentage of a given rate limit threshold that the owning principal can consume.

    Outputs

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

    CreatedBy string
    The Okta user ID of the user who created the principle rate limit entity.
    CreatedDate string
    The date and time the principle rate limit entity was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    The date and time the principle rate limit entity was last updated.
    LastUpdatedBy string
    The Okta user ID of the user who last updated the principle rate limit entity.
    OrgId string
    The unique identifier of the Okta org.
    CreatedBy string
    The Okta user ID of the user who created the principle rate limit entity.
    CreatedDate string
    The date and time the principle rate limit entity was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdate string
    The date and time the principle rate limit entity was last updated.
    LastUpdatedBy string
    The Okta user ID of the user who last updated the principle rate limit entity.
    OrgId string
    The unique identifier of the Okta org.
    createdBy String
    The Okta user ID of the user who created the principle rate limit entity.
    createdDate String
    The date and time the principle rate limit entity was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    The date and time the principle rate limit entity was last updated.
    lastUpdatedBy String
    The Okta user ID of the user who last updated the principle rate limit entity.
    orgId String
    The unique identifier of the Okta org.
    createdBy string
    The Okta user ID of the user who created the principle rate limit entity.
    createdDate string
    The date and time the principle rate limit entity was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdate string
    The date and time the principle rate limit entity was last updated.
    lastUpdatedBy string
    The Okta user ID of the user who last updated the principle rate limit entity.
    orgId string
    The unique identifier of the Okta org.
    created_by str
    The Okta user ID of the user who created the principle rate limit entity.
    created_date str
    The date and time the principle rate limit entity was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_update str
    The date and time the principle rate limit entity was last updated.
    last_updated_by str
    The Okta user ID of the user who last updated the principle rate limit entity.
    org_id str
    The unique identifier of the Okta org.
    createdBy String
    The Okta user ID of the user who created the principle rate limit entity.
    createdDate String
    The date and time the principle rate limit entity was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdate String
    The date and time the principle rate limit entity was last updated.
    lastUpdatedBy String
    The Okta user ID of the user who last updated the principle rate limit entity.
    orgId String
    The unique identifier of the Okta org.

    Look up Existing PrincipalRateLimits Resource

    Get an existing PrincipalRateLimits 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?: PrincipalRateLimitsState, opts?: CustomResourceOptions): PrincipalRateLimits
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_by: Optional[str] = None,
        created_date: Optional[str] = None,
        default_concurrency_percentage: Optional[int] = None,
        default_percentage: Optional[int] = None,
        last_update: Optional[str] = None,
        last_updated_by: Optional[str] = None,
        org_id: Optional[str] = None,
        principal_id: Optional[str] = None,
        principal_type: Optional[str] = None) -> PrincipalRateLimits
    func GetPrincipalRateLimits(ctx *Context, name string, id IDInput, state *PrincipalRateLimitsState, opts ...ResourceOption) (*PrincipalRateLimits, error)
    public static PrincipalRateLimits Get(string name, Input<string> id, PrincipalRateLimitsState? state, CustomResourceOptions? opts = null)
    public static PrincipalRateLimits get(String name, Output<String> id, PrincipalRateLimitsState state, CustomResourceOptions options)
    resources:  _:    type: okta:PrincipalRateLimits    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:
    CreatedBy string
    The Okta user ID of the user who created the principle rate limit entity.
    CreatedDate string
    The date and time the principle rate limit entity was created.
    DefaultConcurrencyPercentage int
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    DefaultPercentage int
    The default percentage of a given rate limit threshold that the owning principal can consume.
    LastUpdate string
    The date and time the principle rate limit entity was last updated.
    LastUpdatedBy string
    The Okta user ID of the user who last updated the principle rate limit entity.
    OrgId string
    The unique identifier of the Okta org.
    PrincipalId string
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    PrincipalType string
    The type of principal, either an API token or an OAuth 2.0 app.
    CreatedBy string
    The Okta user ID of the user who created the principle rate limit entity.
    CreatedDate string
    The date and time the principle rate limit entity was created.
    DefaultConcurrencyPercentage int
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    DefaultPercentage int
    The default percentage of a given rate limit threshold that the owning principal can consume.
    LastUpdate string
    The date and time the principle rate limit entity was last updated.
    LastUpdatedBy string
    The Okta user ID of the user who last updated the principle rate limit entity.
    OrgId string
    The unique identifier of the Okta org.
    PrincipalId string
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    PrincipalType string
    The type of principal, either an API token or an OAuth 2.0 app.
    createdBy String
    The Okta user ID of the user who created the principle rate limit entity.
    createdDate String
    The date and time the principle rate limit entity was created.
    defaultConcurrencyPercentage Integer
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    defaultPercentage Integer
    The default percentage of a given rate limit threshold that the owning principal can consume.
    lastUpdate String
    The date and time the principle rate limit entity was last updated.
    lastUpdatedBy String
    The Okta user ID of the user who last updated the principle rate limit entity.
    orgId String
    The unique identifier of the Okta org.
    principalId String
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principalType String
    The type of principal, either an API token or an OAuth 2.0 app.
    createdBy string
    The Okta user ID of the user who created the principle rate limit entity.
    createdDate string
    The date and time the principle rate limit entity was created.
    defaultConcurrencyPercentage number
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    defaultPercentage number
    The default percentage of a given rate limit threshold that the owning principal can consume.
    lastUpdate string
    The date and time the principle rate limit entity was last updated.
    lastUpdatedBy string
    The Okta user ID of the user who last updated the principle rate limit entity.
    orgId string
    The unique identifier of the Okta org.
    principalId string
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principalType string
    The type of principal, either an API token or an OAuth 2.0 app.
    created_by str
    The Okta user ID of the user who created the principle rate limit entity.
    created_date str
    The date and time the principle rate limit entity was created.
    default_concurrency_percentage int
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    default_percentage int
    The default percentage of a given rate limit threshold that the owning principal can consume.
    last_update str
    The date and time the principle rate limit entity was last updated.
    last_updated_by str
    The Okta user ID of the user who last updated the principle rate limit entity.
    org_id str
    The unique identifier of the Okta org.
    principal_id str
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principal_type str
    The type of principal, either an API token or an OAuth 2.0 app.
    createdBy String
    The Okta user ID of the user who created the principle rate limit entity.
    createdDate String
    The date and time the principle rate limit entity was created.
    defaultConcurrencyPercentage Number
    The default percentage of a given concurrency limit threshold that the owning principal can consume.
    defaultPercentage Number
    The default percentage of a given rate limit threshold that the owning principal can consume.
    lastUpdate String
    The date and time the principle rate limit entity was last updated.
    lastUpdatedBy String
    The Okta user ID of the user who last updated the principle rate limit entity.
    orgId String
    The unique identifier of the Okta org.
    principalId String
    The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
    principalType String
    The type of principal, either an API token or an OAuth 2.0 app.

    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