Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Propelauth Provider
  3. API Docs
  4. ApiKeySettings
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

propelauth.ApiKeySettings

Explore with Pulumi AI

propelauth logo
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

    Api Key Configurations. API Key authentication allows you to create API Keys for your end users as well as your organizations in order to protect requests they make to your product. This resource is for configuring the API key settings in your project.

    Note: API Keys are only available for use in non-test environments for some pricing plans.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.ApiKeySettings;
import com.pulumi.propelauth.ApiKeySettingsArgs;
import com.pulumi.propelauth.inputs.ApiKeySettingsApiKeyConfigArgs;
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) {
        // Configure the API key settings for your PropelAuth project.
        var example = new ApiKeySettings("example", ApiKeySettingsArgs.builder()
            .apiKeyConfig(ApiKeySettingsApiKeyConfigArgs.builder()
                .expiration_options(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .build())
            .invalidateOrgApiKeyUponUserRemoval(true)
            .orgApiKeysEnabled(true)
            .personalApiKeysEnabled(true)
            .build());

    }
}

    resources:
  # Configure the API key settings for your PropelAuth project.
  example:
    type: propelauth:ApiKeySettings
    properties:
      apiKeyConfig:
        expiration_options:
          default: ThreeMonths
          options:
            - TwoWeeks
            - OneMonth
            - ThreeMonths
      invalidateOrgApiKeyUponUserRemoval: true
      orgApiKeysEnabled: true
      personalApiKeysEnabled: true

    Create ApiKeySettings Resource

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

    Constructor syntax

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

@overload
def ApiKeySettings(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_key_config: Optional[ApiKeySettingsApiKeyConfigArgs] = None,
                   invalidate_org_api_key_upon_user_removal: Optional[bool] = None,
                   org_api_key_rate_limit: Optional[ApiKeySettingsOrgApiKeyRateLimitArgs] = None,
                   org_api_keys_enabled: Optional[bool] = None,
                   personal_api_key_rate_limit: Optional[ApiKeySettingsPersonalApiKeyRateLimitArgs] = None,
                   personal_api_keys_enabled: Optional[bool] = None)
    func NewApiKeySettings(ctx *Context, name string, args *ApiKeySettingsArgs, opts ...ResourceOption) (*ApiKeySettings, error)
    public ApiKeySettings(string name, ApiKeySettingsArgs? args = null, CustomResourceOptions? opts = null)
    public ApiKeySettings(String name, ApiKeySettingsArgs args)
public ApiKeySettings(String name, ApiKeySettingsArgs args, CustomResourceOptions options)

    type: propelauth:ApiKeySettings
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 ApiKeySettingsArgs
    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 ApiKeySettingsArgs
    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 ApiKeySettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiKeySettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiKeySettingsArgs
    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 apiKeySettingsResource = new Propelauth.ApiKeySettings("apiKeySettingsResource", new()
{
    ApiKeyConfig = new Propelauth.Inputs.ApiKeySettingsApiKeyConfigArgs
    {
        ExpirationOptions = new Propelauth.Inputs.ApiKeySettingsApiKeyConfigExpirationOptionsArgs
        {
            Default = "string",
            Options = new[]
            {
                "string",
            },
        },
    },
    InvalidateOrgApiKeyUponUserRemoval = false,
    OrgApiKeyRateLimit = new Propelauth.Inputs.ApiKeySettingsOrgApiKeyRateLimitArgs
    {
        AllowPerPeriod = 0,
        PeriodSize = 0,
        PeriodType = "string",
    },
    OrgApiKeysEnabled = false,
    PersonalApiKeyRateLimit = new Propelauth.Inputs.ApiKeySettingsPersonalApiKeyRateLimitArgs
    {
        AllowPerPeriod = 0,
        PeriodSize = 0,
        PeriodType = "string",
    },
    PersonalApiKeysEnabled = false,
});

    example, err := propelauth.NewApiKeySettings(ctx, "apiKeySettingsResource", &propelauth.ApiKeySettingsArgs{
ApiKeyConfig: &.ApiKeySettingsApiKeyConfigArgs{
ExpirationOptions: &.ApiKeySettingsApiKeyConfigExpirationOptionsArgs{
Default: pulumi.String("string"),
Options: pulumi.StringArray{
pulumi.String("string"),
},
},
},
InvalidateOrgApiKeyUponUserRemoval: pulumi.Bool(false),
OrgApiKeyRateLimit: &.ApiKeySettingsOrgApiKeyRateLimitArgs{
AllowPerPeriod: pulumi.Float64(0),
PeriodSize: pulumi.Float64(0),
PeriodType: pulumi.String("string"),
},
OrgApiKeysEnabled: pulumi.Bool(false),
PersonalApiKeyRateLimit: &.ApiKeySettingsPersonalApiKeyRateLimitArgs{
AllowPerPeriod: pulumi.Float64(0),
PeriodSize: pulumi.Float64(0),
PeriodType: pulumi.String("string"),
},
PersonalApiKeysEnabled: pulumi.Bool(false),
})

    var apiKeySettingsResource = new ApiKeySettings("apiKeySettingsResource", ApiKeySettingsArgs.builder()
    .apiKeyConfig(ApiKeySettingsApiKeyConfigArgs.builder()
        .expirationOptions(ApiKeySettingsApiKeyConfigExpirationOptionsArgs.builder()
            .default_("string")
            .options("string")
            .build())
        .build())
    .invalidateOrgApiKeyUponUserRemoval(false)
    .orgApiKeyRateLimit(ApiKeySettingsOrgApiKeyRateLimitArgs.builder()
        .allowPerPeriod(0)
        .periodSize(0)
        .periodType("string")
        .build())
    .orgApiKeysEnabled(false)
    .personalApiKeyRateLimit(ApiKeySettingsPersonalApiKeyRateLimitArgs.builder()
        .allowPerPeriod(0)
        .periodSize(0)
        .periodType("string")
        .build())
    .personalApiKeysEnabled(false)
    .build());

    api_key_settings_resource = propelauth.ApiKeySettings("apiKeySettingsResource",
    api_key_config={
        "expiration_options": {
            "default": "string",
            "options": ["string"],
        },
    },
    invalidate_org_api_key_upon_user_removal=False,
    org_api_key_rate_limit={
        "allow_per_period": 0,
        "period_size": 0,
        "period_type": "string",
    },
    org_api_keys_enabled=False,
    personal_api_key_rate_limit={
        "allow_per_period": 0,
        "period_size": 0,
        "period_type": "string",
    },
    personal_api_keys_enabled=False)

    const apiKeySettingsResource = new propelauth.ApiKeySettings("apiKeySettingsResource", {
    apiKeyConfig: {
        expirationOptions: {
            "default": "string",
            options: ["string"],
        },
    },
    invalidateOrgApiKeyUponUserRemoval: false,
    orgApiKeyRateLimit: {
        allowPerPeriod: 0,
        periodSize: 0,
        periodType: "string",
    },
    orgApiKeysEnabled: false,
    personalApiKeyRateLimit: {
        allowPerPeriod: 0,
        periodSize: 0,
        periodType: "string",
    },
    personalApiKeysEnabled: false,
});

    type: propelauth:ApiKeySettings
properties:
    apiKeyConfig:
        expirationOptions:
            default: string
            options:
                - string
    invalidateOrgApiKeyUponUserRemoval: false
    orgApiKeyRateLimit:
        allowPerPeriod: 0
        periodSize: 0
        periodType: string
    orgApiKeysEnabled: false
    personalApiKeyRateLimit:
        allowPerPeriod: 0
        periodSize: 0
        periodType: string
    personalApiKeysEnabled: false

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

    ApiKeyConfig ApiKeySettingsApiKeyConfig
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    InvalidateOrgApiKeyUponUserRemoval bool
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    OrgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimit
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    OrgApiKeysEnabled bool
    Allow users to create API keys for their organization. The default setting is false.
    PersonalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimit
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    PersonalApiKeysEnabled bool
    Allow users to create personal API keys. The default setting is false.
    ApiKeyConfig ApiKeySettingsApiKeyConfigArgs
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    InvalidateOrgApiKeyUponUserRemoval bool
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    OrgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimitArgs
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    OrgApiKeysEnabled bool
    Allow users to create API keys for their organization. The default setting is false.
    PersonalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimitArgs
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    PersonalApiKeysEnabled bool
    Allow users to create personal API keys. The default setting is false.
    apiKeyConfig ApiKeySettingsApiKeyConfig
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidateOrgApiKeyUponUserRemoval Boolean
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    orgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimit
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    orgApiKeysEnabled Boolean
    Allow users to create API keys for their organization. The default setting is false.
    personalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimit
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personalApiKeysEnabled Boolean
    Allow users to create personal API keys. The default setting is false.
    apiKeyConfig ApiKeySettingsApiKeyConfig
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidateOrgApiKeyUponUserRemoval boolean
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    orgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimit
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    orgApiKeysEnabled boolean
    Allow users to create API keys for their organization. The default setting is false.
    personalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimit
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personalApiKeysEnabled boolean
    Allow users to create personal API keys. The default setting is false.
    api_key_config ApiKeySettingsApiKeyConfigArgs
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidate_org_api_key_upon_user_removal bool
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    org_api_key_rate_limit ApiKeySettingsOrgApiKeyRateLimitArgs
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    org_api_keys_enabled bool
    Allow users to create API keys for their organization. The default setting is false.
    personal_api_key_rate_limit ApiKeySettingsPersonalApiKeyRateLimitArgs
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personal_api_keys_enabled bool
    Allow users to create personal API keys. The default setting is false.
    apiKeyConfig Property Map
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidateOrgApiKeyUponUserRemoval Boolean
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    orgApiKeyRateLimit Property Map
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    orgApiKeysEnabled Boolean
    Allow users to create API keys for their organization. The default setting is false.
    personalApiKeyRateLimit Property Map
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personalApiKeysEnabled Boolean
    Allow users to create personal API keys. The default setting is false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiKeySettings 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 ApiKeySettings Resource

    Get an existing ApiKeySettings 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?: ApiKeySettingsState, opts?: CustomResourceOptions): ApiKeySettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key_config: Optional[ApiKeySettingsApiKeyConfigArgs] = None,
        invalidate_org_api_key_upon_user_removal: Optional[bool] = None,
        org_api_key_rate_limit: Optional[ApiKeySettingsOrgApiKeyRateLimitArgs] = None,
        org_api_keys_enabled: Optional[bool] = None,
        personal_api_key_rate_limit: Optional[ApiKeySettingsPersonalApiKeyRateLimitArgs] = None,
        personal_api_keys_enabled: Optional[bool] = None) -> ApiKeySettings
    func GetApiKeySettings(ctx *Context, name string, id IDInput, state *ApiKeySettingsState, opts ...ResourceOption) (*ApiKeySettings, error)
    public static ApiKeySettings Get(string name, Input<string> id, ApiKeySettingsState? state, CustomResourceOptions? opts = null)
    public static ApiKeySettings get(String name, Output<String> id, ApiKeySettingsState state, CustomResourceOptions options)
    resources:  _:    type: propelauth:ApiKeySettings    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:
    ApiKeyConfig ApiKeySettingsApiKeyConfig
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    InvalidateOrgApiKeyUponUserRemoval bool
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    OrgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimit
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    OrgApiKeysEnabled bool
    Allow users to create API keys for their organization. The default setting is false.
    PersonalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimit
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    PersonalApiKeysEnabled bool
    Allow users to create personal API keys. The default setting is false.
    ApiKeyConfig ApiKeySettingsApiKeyConfigArgs
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    InvalidateOrgApiKeyUponUserRemoval bool
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    OrgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimitArgs
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    OrgApiKeysEnabled bool
    Allow users to create API keys for their organization. The default setting is false.
    PersonalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimitArgs
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    PersonalApiKeysEnabled bool
    Allow users to create personal API keys. The default setting is false.
    apiKeyConfig ApiKeySettingsApiKeyConfig
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidateOrgApiKeyUponUserRemoval Boolean
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    orgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimit
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    orgApiKeysEnabled Boolean
    Allow users to create API keys for their organization. The default setting is false.
    personalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimit
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personalApiKeysEnabled Boolean
    Allow users to create personal API keys. The default setting is false.
    apiKeyConfig ApiKeySettingsApiKeyConfig
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidateOrgApiKeyUponUserRemoval boolean
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    orgApiKeyRateLimit ApiKeySettingsOrgApiKeyRateLimit
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    orgApiKeysEnabled boolean
    Allow users to create API keys for their organization. The default setting is false.
    personalApiKeyRateLimit ApiKeySettingsPersonalApiKeyRateLimit
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personalApiKeysEnabled boolean
    Allow users to create personal API keys. The default setting is false.
    api_key_config ApiKeySettingsApiKeyConfigArgs
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidate_org_api_key_upon_user_removal bool
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    org_api_key_rate_limit ApiKeySettingsOrgApiKeyRateLimitArgs
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    org_api_keys_enabled bool
    Allow users to create API keys for their organization. The default setting is false.
    personal_api_key_rate_limit ApiKeySettingsPersonalApiKeyRateLimitArgs
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personal_api_keys_enabled bool
    Allow users to create personal API keys. The default setting is false.
    apiKeyConfig Property Map
    API Key Configuration. This is for setting the options available to your users when creating an API key.
    invalidateOrgApiKeyUponUserRemoval Boolean
    If true, invalidate org API keys when the user that created them is removed from the organization. The default setting is false.
    orgApiKeyRateLimit Property Map
    Organization API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' organizations' API keys. This is calculated and applied per organization for all keys the organization owns as opposed to per key. Note: Rate limits are only available on some pricing plans.
    orgApiKeysEnabled Boolean
    Allow users to create API keys for their organization. The default setting is false.
    personalApiKeyRateLimit Property Map
    Personal API Key Rate Limit. This sets the rate limit that will be applied to validations on your end users' personal API keys. This is calculated and applied per user for all keys they own as opposed to per key.Note: Rate limits are only available on some pricing plans.
    personalApiKeysEnabled Boolean
    Allow users to create personal API keys. The default setting is false.

    Supporting Types

    ApiKeySettingsApiKeyConfig, ApiKeySettingsApiKeyConfigArgs

    ExpirationOptions ApiKeySettingsApiKeyConfigExpirationOptions
    API Key Expiration Options. This is for setting the options available to your users when creating an API key.
    ExpirationOptions ApiKeySettingsApiKeyConfigExpirationOptions
    API Key Expiration Options. This is for setting the options available to your users when creating an API key.
    expirationOptions ApiKeySettingsApiKeyConfigExpirationOptions
    API Key Expiration Options. This is for setting the options available to your users when creating an API key.
    expirationOptions ApiKeySettingsApiKeyConfigExpirationOptions
    API Key Expiration Options. This is for setting the options available to your users when creating an API key.
    expiration_options ApiKeySettingsApiKeyConfigExpirationOptions
    API Key Expiration Options. This is for setting the options available to your users when creating an API key.
    expirationOptions Property Map
    API Key Expiration Options. This is for setting the options available to your users when creating an API key.

    ApiKeySettingsApiKeyConfigExpirationOptions, ApiKeySettingsApiKeyConfigExpirationOptionsArgs

    Default string
    The default expiration option for an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    Options List<string>
    The options available for the expiration of an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    Default string
    The default expiration option for an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    Options []string
    The options available for the expiration of an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    default_ String
    The default expiration option for an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    options List<String>
    The options available for the expiration of an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    default string
    The default expiration option for an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    options string[]
    The options available for the expiration of an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    default str
    The default expiration option for an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    options Sequence[str]
    The options available for the expiration of an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    default String
    The default expiration option for an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.
    options List<String>
    The options available for the expiration of an API key. Valid values are TwoWeeks, OneMonth, ThreeMonths, SixMonths, OneYear, and Never.

    ApiKeySettingsOrgApiKeyRateLimit, ApiKeySettingsOrgApiKeyRateLimitArgs

    AllowPerPeriod double
    The number of requests allowed per period.
    PeriodSize double
    The number of period_type units for calculating and applying your rate limit.
    PeriodType string
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    AllowPerPeriod float64
    The number of requests allowed per period.
    PeriodSize float64
    The number of period_type units for calculating and applying your rate limit.
    PeriodType string
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allowPerPeriod Double
    The number of requests allowed per period.
    periodSize Double
    The number of period_type units for calculating and applying your rate limit.
    periodType String
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allowPerPeriod number
    The number of requests allowed per period.
    periodSize number
    The number of period_type units for calculating and applying your rate limit.
    periodType string
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allow_per_period float
    The number of requests allowed per period.
    period_size float
    The number of period_type units for calculating and applying your rate limit.
    period_type str
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allowPerPeriod Number
    The number of requests allowed per period.
    periodSize Number
    The number of period_type units for calculating and applying your rate limit.
    periodType String
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.

    ApiKeySettingsPersonalApiKeyRateLimit, ApiKeySettingsPersonalApiKeyRateLimitArgs

    AllowPerPeriod double
    The number of requests allowed per period.
    PeriodSize double
    The number of period_type units for calculating and applying your rate limit.
    PeriodType string
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    AllowPerPeriod float64
    The number of requests allowed per period.
    PeriodSize float64
    The number of period_type units for calculating and applying your rate limit.
    PeriodType string
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allowPerPeriod Double
    The number of requests allowed per period.
    periodSize Double
    The number of period_type units for calculating and applying your rate limit.
    periodType String
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allowPerPeriod number
    The number of requests allowed per period.
    periodSize number
    The number of period_type units for calculating and applying your rate limit.
    periodType string
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allow_per_period float
    The number of requests allowed per period.
    period_size float
    The number of period_type units for calculating and applying your rate limit.
    period_type str
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.
    allowPerPeriod Number
    The number of requests allowed per period.
    periodSize Number
    The number of period_type units for calculating and applying your rate limit.
    periodType String
    The unit of time for time for calculating and applying your rate limit. Valid values are seconds, minutes, hours, or days.

    Import

    As there is only one api_key_settings per project there’s no need to specify the id,

    $ pulumi import propelauth:index/apiKeySettings:ApiKeySettings but requires an id to be specified, so we can use an arbitrary string here.

    $ pulumi import propelauth:index/apiKeySettings:ApiKeySettings example arbitrary_string_here

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

    Package Details

    Repository
    propelauth propelauth/terraform-provider-propelauth
    License
    Notes
    This Pulumi package is based on the propelauth Terraform Provider.
    propelauth logo
    propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
    propelauth/terraform-provider-propelauth