rate_limit_settings_per_client

Creates, updates, deletes, gets or lists a rate_limit_settings_per_client resource.

Overview

Name	rate_limit_settings_per_client
Type	Resource
Id	okta.rate_limit_settings.rate_limit_settings_per_client

Fields

The following fields are returned by SELECT queries:

get_rate_limit_settings_per_client

Name	Datatype	Description
defaultMode	string	The default PerClientRateLimitMode that applies to any use case in the absence of a more specific override
useCaseModeOverrides	object	A map of Per-Client Rate Limit Use Case to the applicable PerClientRateLimitMode. Overrides the defaultMode property for the specified use cases.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_rate_limit_settings_per_client	select	subdomain		Retrieves the currently configured Per-Client Rate Limit Settings
replace_rate_limit_settings_per_client	replace	subdomain, data__defaultMode		Replaces the Per-Client Rate Limit Settings and returns the configured properties

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

get_rate_limit_settings_per_client

Retrieves the currently configured Per-Client Rate Limit Settings

SELECT
defaultMode,
useCaseModeOverrides
FROM okta.rate_limit_settings.rate_limit_settings_per_client
WHERE subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_rate_limit_settings_per_client

Replaces the Per-Client Rate Limit Settings and returns the configured properties

REPLACE okta.rate_limit_settings.rate_limit_settings_per_client
SET 
data__defaultMode = '{{ defaultMode }}',
data__useCaseModeOverrides = '{{ useCaseModeOverrides }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__defaultMode = '{{ defaultMode }}' --required
RETURNING
defaultMode,
useCaseModeOverrides
;