1. Packages
  2. Okta Provider
  3. API Docs
  4. getPrincipalRateLimits
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.getPrincipalRateLimits

okta logo
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Get the entitlements for a user and resource after evaluating all grants.

    Example Usage

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

const example = okta.getPrincipalRateLimits({
    id: "<principal_rate_limit_id>",
});

    import pulumi
import pulumi_okta as okta

example = okta.get_principal_rate_limits(id="<principal_rate_limit_id>")

    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.LookupPrincipalRateLimits(ctx, &okta.LookupPrincipalRateLimitsArgs{
			Id: "<principal_rate_limit_id>",
		}, nil)
		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 = Okta.GetPrincipalRateLimits.Invoke(new()
    {
        Id = "<principal_rate_limit_id>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetPrincipalRateLimitsArgs;
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) {
        final var example = OktaFunctions.getPrincipalRateLimits(GetPrincipalRateLimitsArgs.builder()
            .id("<principal_rate_limit_id>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: okta:getPrincipalRateLimits
      arguments:
        id: <principal_rate_limit_id>

    Using getPrincipalRateLimits

    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 getPrincipalRateLimits(args: GetPrincipalRateLimitsArgs, opts?: InvokeOptions): Promise<GetPrincipalRateLimitsResult>
function getPrincipalRateLimitsOutput(args: GetPrincipalRateLimitsOutputArgs, opts?: InvokeOptions): Output<GetPrincipalRateLimitsResult>
    def get_principal_rate_limits(id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPrincipalRateLimitsResult
def get_principal_rate_limits_output(id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPrincipalRateLimitsResult]
    func LookupPrincipalRateLimits(ctx *Context, args *LookupPrincipalRateLimitsArgs, opts ...InvokeOption) (*LookupPrincipalRateLimitsResult, error)
func LookupPrincipalRateLimitsOutput(ctx *Context, args *LookupPrincipalRateLimitsOutputArgs, opts ...InvokeOption) LookupPrincipalRateLimitsResultOutput

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

    public static class GetPrincipalRateLimits 
{
    public static Task<GetPrincipalRateLimitsResult> InvokeAsync(GetPrincipalRateLimitsArgs args, InvokeOptions? opts = null)
    public static Output<GetPrincipalRateLimitsResult> Invoke(GetPrincipalRateLimitsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrincipalRateLimitsResult> getPrincipalRateLimits(GetPrincipalRateLimitsArgs args, InvokeOptions options)
public static Output<GetPrincipalRateLimitsResult> getPrincipalRateLimits(GetPrincipalRateLimitsArgs args, InvokeOptions options)

    fn::invoke:
  function: okta:index/getPrincipalRateLimits:getPrincipalRateLimits
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The unique identifier of the principle rate limit entity.
    Id string
    The unique identifier of the principle rate limit entity.
    id String
    The unique identifier of the principle rate limit entity.
    id string
    The unique identifier of the principle rate limit entity.
    id str
    The unique identifier of the principle rate limit entity.
    id String
    The unique identifier of the principle rate limit entity.

    getPrincipalRateLimits Result

    The following output properties are available:

    CreatedBy string
    The ID of the user who created the principal rate limit.
    CreatedDate string
    The date and time when the principal rate limit was created.
    DefaultConcurrencyPercentage int
    The default concurrency percentage for the principal rate limit.
    DefaultPercentage int
    The default percentage for the principal rate limit.
    Id string
    The unique identifier of the principle rate limit entity.
    LastUpdate string
    LastUpdatedBy string
    The ID of the user who last updated the principal rate limit.
    OrgId string
    The unique identifier of the Okta organization.
    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 ID of the user who created the principal rate limit.
    CreatedDate string
    The date and time when the principal rate limit was created.
    DefaultConcurrencyPercentage int
    The default concurrency percentage for the principal rate limit.
    DefaultPercentage int
    The default percentage for the principal rate limit.
    Id string
    The unique identifier of the principle rate limit entity.
    LastUpdate string
    LastUpdatedBy string
    The ID of the user who last updated the principal rate limit.
    OrgId string
    The unique identifier of the Okta organization.
    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 ID of the user who created the principal rate limit.
    createdDate String
    The date and time when the principal rate limit was created.
    defaultConcurrencyPercentage Integer
    The default concurrency percentage for the principal rate limit.
    defaultPercentage Integer
    The default percentage for the principal rate limit.
    id String
    The unique identifier of the principle rate limit entity.
    lastUpdate String
    lastUpdatedBy String
    The ID of the user who last updated the principal rate limit.
    orgId String
    The unique identifier of the Okta organization.
    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 ID of the user who created the principal rate limit.
    createdDate string
    The date and time when the principal rate limit was created.
    defaultConcurrencyPercentage number
    The default concurrency percentage for the principal rate limit.
    defaultPercentage number
    The default percentage for the principal rate limit.
    id string
    The unique identifier of the principle rate limit entity.
    lastUpdate string
    lastUpdatedBy string
    The ID of the user who last updated the principal rate limit.
    orgId string
    The unique identifier of the Okta organization.
    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 ID of the user who created the principal rate limit.
    created_date str
    The date and time when the principal rate limit was created.
    default_concurrency_percentage int
    The default concurrency percentage for the principal rate limit.
    default_percentage int
    The default percentage for the principal rate limit.
    id str
    The unique identifier of the principle rate limit entity.
    last_update str
    last_updated_by str
    The ID of the user who last updated the principal rate limit.
    org_id str
    The unique identifier of the Okta organization.
    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 ID of the user who created the principal rate limit.
    createdDate String
    The date and time when the principal rate limit was created.
    defaultConcurrencyPercentage Number
    The default concurrency percentage for the principal rate limit.
    defaultPercentage Number
    The default percentage for the principal rate limit.
    id String
    The unique identifier of the principle rate limit entity.
    lastUpdate String
    lastUpdatedBy String
    The ID of the user who last updated the principal rate limit.
    orgId String
    The unique identifier of the Okta organization.
    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
    Viewing docs for Okta v6.3.1
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-okta
      Try Pulumi Cloud free. Your team will thank you.