warning_thresholds
Creates, updates, deletes, gets or lists a warning_thresholds resource.
Overview
| Name | warning_thresholds |
| Type | Resource |
| Id | okta.rate_limit_settings.warning_thresholds |
Fields
The following fields are returned by SELECT queries:
- get_rate_limit_settings_warning_threshold
| Name | Datatype | Description |
|---|---|---|
warningThreshold | integer | The threshold value (percentage) of a rate limit that, when exceeded, triggers a warning notification. By default, this value is 90 for Workforce orgs and 60 for CIAM orgs. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_rate_limit_settings_warning_threshold | select | subdomain | Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded | |
replace_rate_limit_settings_warning_threshold | replace | subdomain, data__warningThreshold | Replaces the Rate Limit Warning Threshold Percentage and returns the configured property |
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_warning_threshold
Retrieves the currently configured threshold for warning notifications when the API's rate limit is exceeded
SELECT
warningThreshold
FROM okta.rate_limit_settings.warning_thresholds
WHERE subdomain = '{{ subdomain }}' -- required;
REPLACE examples
- replace_rate_limit_settings_warning_threshold
Replaces the Rate Limit Warning Threshold Percentage and returns the configured property
REPLACE okta.rate_limit_settings.warning_thresholds
SET
data__warningThreshold = {{ warningThreshold }}
WHERE
subdomain = '{{ subdomain }}' --required
AND data__warningThreshold = '{{ warningThreshold }}' --required
RETURNING
warningThreshold;