Principal Rate Limits

The Principal Rate Limits API provides operations to manage Principal Rate Limits for your organization.

List all principal rate limits
OAuth 2.0: okta.principalRateLimits.read

Lists all Principal Rate Limit entities considering the provided parameters

Request
query Parameters
filter
required
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".

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> <= 50
Default: 20

Specifies the number of items to return in a single response page.

Responses
200

OK

400

Bad Request

403

Forbidden

429

Too Many Requests

get/api/v1/principal-rate-limits
Request samples 
Response samples 
application/json
[
  • {
    • "id": "prlh5hd7qct3aHDry1f6",
    • "orgId": "00o7xut90ucsjAQ7S1e6",
    • "principalId": "00T14q3ns31qMEJUU1d7",
    • "principalType": "SSWS_TOKEN",
    • "defaultPercentage": 50,
    • "defaultConcurrencyPercentage": 50,
    • "lastUpdate": "2024-09-12T17:28:56.000Z",
    • "lastUpdatedBy": "00uid52637YwIXkJq1d4",
    • "createdDate": "2024-09-12T17:28:56.000Z",
    • "createdBy": "00u7xut94qEWYx5ss1d4"
    },
  • {
    • "id": "prlid6w9ilOWlVbpG1f6",
    • "orgId": "00o7xut90ucsjAQ7S1e6",
    • "principalId": "00T16ewcxyIrMV6Lb1d7",
    • "principalType": "SSWS_TOKEN",
    • "defaultPercentage": 50,
    • "defaultConcurrencyPercentage": 50,
    • "lastUpdate": "2024-11-13T17:07:14.000Z",
    • "lastUpdatedBy": "00uid52637YwIXkJq1d4",
    • "createdDate": "2024-11-13T17:07:14.000Z",
    • "createdBy": "00uid52637YwIXkJq1d4"
    }
]
Create a principal rate limit
OAuth 2.0: okta.principalRateLimits.manage
Creates a new principal rate limit entity. Okta only allows one principal rate limit entity per org and principal.


Request 
Request Body schema: application/json
required
principalId
required
string
The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.


 
principalType
required
string (PrincipalType) 
The type of principal, either an API token or an OAuth 2.0 app


 Enum: "OAUTH_CLIENT" "SSWS_TOKEN"  
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


 
Responses 
201
Created


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


post/api/v1/principal-rate-limits
Request samples 
application/json
{
  • "principalId": "prlh5hd6act3aHDrr1f5",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75
}
Response samples 
application/json
{
  • "id": "0oacamvryxiyMqgiY1e5",
  • "orgId": "org1234",
  • "principalId": "prlh5hd6act3aHDrr1f5",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75,
  • "createdDate": "2022-05-19T20:05:32.720Z",
  • "createdBy": "00u7xut94qEWYx5ss1d4",
  • "lastUpdate": "2022-05-20T21:13:07.410Z",
  • "lastUpdatedBy": "00u7xut94qEWYx5ss1d4"
}
Retrieve a principal rate limit
OAuth 2.0: okta.principalRateLimits.read
Retrieves a principal rate limit entity by principalRateLimitId


Request 
path Parameters
principalRateLimitId
required
string
ID of the principal rate limit


 
 Example:  0oacamvryxiyMqgiY1d7
Responses 
200
OK


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/principal-rate-limits/{principalRateLimitId}
Request samples 
Response samples 
application/json
{
  • "id": "0oacamvryxiyMqgiY1e5",
  • "orgId": "org1234",
  • "principalId": "prlh5hd6act3aHDrr1f5",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75,
  • "createdDate": "2022-05-19T20:05:32.720Z",
  • "createdBy": "00u7xut94qEWYx5ss1d4",
  • "lastUpdate": "2022-05-20T21:13:07.410Z",
  • "lastUpdatedBy": "00u7xut94qEWYx5ss1d4"
}
Replace a principal rate limit
OAuth 2.0: okta.principalRateLimits.manage
Replaces a principal rate limit entity by principalRateLimitId


Request 
path Parameters
principalRateLimitId
required
string
ID of the principal rate limit


 
 Example:  0oacamvryxiyMqgiY1d7
Request Body schema: application/json
required
principalId
required
string
The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app.


 
principalType
required
string (PrincipalType) 
The type of principal, either an API token or an OAuth 2.0 app


 Enum: "OAUTH_CLIENT" "SSWS_TOKEN"  
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


 
Responses 
200
OK


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/principal-rate-limits/{principalRateLimitId}
Request samples 
application/json
{
  • "principalId": "prlh5hd6act3aHDrr1f5",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75
}
Response samples 
application/json
{
  • "id": "0oacamvryxiyMqgiY1e5",
  • "orgId": "org1234",
  • "principalId": "prlh5hd6act3aHDrr1f5",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75,
  • "createdDate": "2022-05-19T20:05:32.720Z",
  • "createdBy": "00u7xut94qEWYx5ss1d4",
  • "lastUpdate": "2022-05-20T21:13:07.410Z",
  • "lastUpdatedBy": "00u7xut94qEWYx5ss1d4"
}