Package com.okta.sdk.resource.api

Class PrincipalRateLimitApi

java.lang.Object

com.okta.sdk.resource.api.PrincipalRateLimitApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
           comments="Generator version: 7.15.0")
public class PrincipalRateLimitApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PrincipalRateLimitApi()
PrincipalRateLimitApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
PrincipalRateLimitEntity	createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity)	Create a principal rate limit Creates a new principal rate limit entity.
PrincipalRateLimitEntity	createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity, Map<String,String> additionalHeaders)	Create a principal rate limit Creates a new principal rate limit entity.
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
PrincipalRateLimitEntity	getPrincipalRateLimitEntity(String principalRateLimitId)	Retrieve a principal rate limit Retrieves a principal rate limit entity by `principalRateLimitId`
PrincipalRateLimitEntity	getPrincipalRateLimitEntity(String principalRateLimitId, Map<String,String> additionalHeaders)	Retrieve a principal rate limit Retrieves a principal rate limit entity by `principalRateLimitId`
List<PrincipalRateLimitEntity>	listPrincipalRateLimitEntities(String filter, String after, Integer limit)	List all principal rate limits Lists all Principal Rate Limit entities considering the provided parameters
List<PrincipalRateLimitEntity>	listPrincipalRateLimitEntities(String filter, String after, Integer limit, Map<String,String> additionalHeaders)	List all principal rate limits Lists all Principal Rate Limit entities considering the provided parameters
Iterable<PrincipalRateLimitEntity>	listPrincipalRateLimitEntitiesPaged(String filter, String after, Integer limit)	List all principal rate limits (Paginated) Lists all Principal Rate Limit entities considering the provided parameters This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<PrincipalRateLimitEntity>	listPrincipalRateLimitEntitiesPaged(String filter, String after, Integer limit, Map<String,String> additionalHeaders)	List all principal rate limits (Paginated with additional headers) Lists all Principal Rate Limit entities considering the provided parameters This method returns a lazy, paginated iterable that automatically handles pagination.
PrincipalRateLimitEntity	replacePrincipalRateLimitEntity(String principalRateLimitId, PrincipalRateLimitEntity entity)	Replace a principal rate limit Replaces a principal rate limit entity by `principalRateLimitId`
PrincipalRateLimitEntity	replacePrincipalRateLimitEntity(String principalRateLimitId, PrincipalRateLimitEntity entity, Map<String,String> additionalHeaders)	Replace a principal rate limit Replaces a principal rate limit entity by `principalRateLimitId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrincipalRateLimitApi

public PrincipalRateLimitApi()

PrincipalRateLimitApi

public PrincipalRateLimitApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPrincipalRateLimitEntity

public PrincipalRateLimitEntity createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity)
                                                        throws ApiException

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

Parameters:

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

createPrincipalRateLimitEntity

public PrincipalRateLimitEntity createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity,
 Map<String,String> additionalHeaders)
                                                        throws ApiException

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

Parameters:

entity - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

getPrincipalRateLimitEntity

public PrincipalRateLimitEntity getPrincipalRateLimitEntity(String principalRateLimitId)
                                                     throws ApiException

Retrieve a principal rate limit Retrieves a principal rate limit entity by `principalRateLimitId`

Parameters:

principalRateLimitId - ID of the principal rate limit (required)

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

getPrincipalRateLimitEntity

public PrincipalRateLimitEntity getPrincipalRateLimitEntity(String principalRateLimitId,
 Map<String,String> additionalHeaders)
                                                     throws ApiException

Retrieve a principal rate limit Retrieves a principal rate limit entity by `principalRateLimitId`

Parameters:

principalRateLimitId - ID of the principal rate limit (required)

additionalHeaders - additionalHeaders for this call

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

listPrincipalRateLimitEntities

public List<PrincipalRateLimitEntity> listPrincipalRateLimitEntities(String filter,
 String after,
 Integer limit)
                                                              throws ApiException

List all principal rate limits Lists all Principal Rate Limit entities considering the provided parameters

Parameters:

filter - 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\"`. (required)

after - 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](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of items to return in a single response page. (optional, default to 20)

Returns:

List<PrincipalRateLimitEntity>

Throws:

ApiException - if fails to make API call

listPrincipalRateLimitEntities

public List<PrincipalRateLimitEntity> listPrincipalRateLimitEntities(String filter,
 String after,
 Integer limit,
 Map<String,String> additionalHeaders)
                                                              throws ApiException

List all principal rate limits Lists all Principal Rate Limit entities considering the provided parameters

Parameters:

filter - 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\"`. (required)

after - 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](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of items to return in a single response page. (optional, default to 20)

additionalHeaders - additionalHeaders for this call

Returns:

List<PrincipalRateLimitEntity>

Throws:

ApiException - if fails to make API call

listPrincipalRateLimitEntitiesPaged

public Iterable<PrincipalRateLimitEntity> listPrincipalRateLimitEntitiesPaged(String filter,
 String after,
 Integer limit)

List all principal rate limits (Paginated) Lists all Principal Rate Limit entities considering the provided parameters This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

filter - 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\"`. (required)

after - 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](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of items to return in a single response page. (optional, default to 20)

Returns:

Iterable<PrincipalRateLimitEntity> lazy iterable over all pages

listPrincipalRateLimitEntitiesPaged

public Iterable<PrincipalRateLimitEntity> listPrincipalRateLimitEntitiesPaged(String filter,
 String after,
 Integer limit,
 Map<String,String> additionalHeaders)

List all principal rate limits (Paginated with additional headers) Lists all Principal Rate Limit entities considering the provided parameters This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

filter - 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\"`. (required)

after - 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](https://developer.okta.com/docs/api/#pagination). (optional)

limit - Specifies the number of items to return in a single response page. (optional, default to 20)

additionalHeaders - additional headers for this call

Returns:

Iterable<PrincipalRateLimitEntity> lazy iterable over all pages

replacePrincipalRateLimitEntity

public PrincipalRateLimitEntity replacePrincipalRateLimitEntity(String principalRateLimitId,
 PrincipalRateLimitEntity entity)
                                                         throws ApiException

Replace a principal rate limit Replaces a principal rate limit entity by `principalRateLimitId`

Parameters:

principalRateLimitId - ID of the principal rate limit (required)

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

replacePrincipalRateLimitEntity

public PrincipalRateLimitEntity replacePrincipalRateLimitEntity(String principalRateLimitId,
 PrincipalRateLimitEntity entity,
 Map<String,String> additionalHeaders)
                                                         throws ApiException

Replace a principal rate limit Replaces a principal rate limit entity by `principalRateLimitId`

Parameters:

principalRateLimitId - ID of the principal rate limit (required)

entity - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PrincipalRateLimitEntity

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()