principal_rate_limit_entities

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

Overview

Name	principal_rate_limit_entities
Type	Resource
Id	okta.principal_rate_limits.principal_rate_limit_entities

Fields

The following fields are returned by SELECT queries:

get_principal_rate_limit_entity

Name	Datatype	Description
id	string	The unique identifier of the principle rate limit entity
createdBy	string	The Okta user ID of the user who created the principle rate limit entity
createdDate	string (date-time)	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 (date-time)	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 (OAUTH_CLIENT, SSWS_TOKEN)

list_principal_rate_limit_entities

Name	Datatype	Description
id	string	The unique identifier of the principle rate limit entity
createdBy	string	The Okta user ID of the user who created the principle rate limit entity
createdDate	string (date-time)	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 (date-time)	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 (OAUTH_CLIENT, SSWS_TOKEN)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_principal_rate_limit_entity	select	principalRateLimitId, subdomain		Retrieves a principal rate limit entity by principalRateLimitId
list_principal_rate_limit_entities	select	filter, subdomain	after, limit	Lists all Principal Rate Limit entities considering the provided parameters
create_principal_rate_limit_entity	insert	subdomain, principalId, principalType		Creates a new principal rate limit entity. Okta only allows one principal rate limit entity per org and principal.
replace_principal_rate_limit_entity	replace	principalRateLimitId, subdomain, principalId, principalType		Replaces a principal rate limit entity by principalRateLimitId

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
filter	string	Filters the list of principal rate limit entities by the provided principal type (principalType). For example, filter=principalType eq "SSWS_TOKEN" or filter=principalType eq "OAUTH_CLIENT".
principalRateLimitId	string	ID of the principal rate limit
subdomain	string	(default: my-org)
after	string	The cursor to use for pagination. It's an opaque string that specifies your current location in the list and is obtained from the Link response header. See Pagination.
limit	integer (int32)	Specifies the number of items to return in a single response page.

SELECT examples

get_principal_rate_limit_entity

Retrieves a principal rate limit entity by principalRateLimitId

SELECT
id,
createdBy,
createdDate,
defaultConcurrencyPercentage,
defaultPercentage,
lastUpdate,
lastUpdatedBy,
orgId,
principalId,
principalType
FROM okta.principal_rate_limits.principal_rate_limit_entities
WHERE principalRateLimitId = '{{ principalRateLimitId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_principal_rate_limit_entities

Lists all Principal Rate Limit entities considering the provided parameters

SELECT
id,
createdBy,
createdDate,
defaultConcurrencyPercentage,
defaultPercentage,
lastUpdate,
lastUpdatedBy,
orgId,
principalId,
principalType
FROM okta.principal_rate_limits.principal_rate_limit_entities
WHERE filter = '{{ filter }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND after = '{{ after }}'
AND limit = '{{ limit }}'
;

INSERT examples

create_principal_rate_limit_entity

Creates a new principal rate limit entity. Okta only allows one principal rate limit entity per org and principal.

INSERT INTO okta.principal_rate_limits.principal_rate_limit_entities (
defaultConcurrencyPercentage,
defaultPercentage,
principalId,
principalType,
subdomain
)
SELECT 
{{ defaultConcurrencyPercentage }},
{{ defaultPercentage }},
'{{ principalId }}' /* required */,
'{{ principalType }}' /* required */,
'{{ subdomain }}'
RETURNING
id,
createdBy,
createdDate,
defaultConcurrencyPercentage,
defaultPercentage,
lastUpdate,
lastUpdatedBy,
orgId,
principalId,
principalType
;

Manifest

# Description fields are for documentation purposes
- name: principal_rate_limit_entities
props:
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the principal_rate_limit_entities resource.
  - name: defaultConcurrencyPercentage
    value: {{ defaultConcurrencyPercentage }}
    description: |
      The default percentage of a given concurrency limit threshold that the owning principal can consume
  - name: defaultPercentage
    value: {{ defaultPercentage }}
    description: |
      The default percentage of a given rate limit threshold that the owning principal can consume
  - name: principalId
    value: "{{ principalId }}"
    description: |
      The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.
  - name: principalType
    value: "{{ principalType }}"
    description: |
      The type of principal, either an API token or an OAuth 2.0 app
    valid_values: ['OAUTH_CLIENT', 'SSWS_TOKEN']

REPLACE examples

replace_principal_rate_limit_entity

Replaces a principal rate limit entity by principalRateLimitId

REPLACE okta.principal_rate_limits.principal_rate_limit_entities
SET 
defaultConcurrencyPercentage = {{ defaultConcurrencyPercentage }},
defaultPercentage = {{ defaultPercentage }},
principalId = '{{ principalId }}',
principalType = '{{ principalType }}'
WHERE 
principalRateLimitId = '{{ principalRateLimitId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND principalId = '{{ principalId }}' --required
AND principalType = '{{ principalType }}' --required
RETURNING
id,
createdBy,
createdDate,
defaultConcurrencyPercentage,
defaultPercentage,
lastUpdate,
lastUpdatedBy,
orgId,
principalId,
principalType;