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
string
after
string
limit
integer <int32> <= 50
Default: 20
Responses
200

OK

400

Bad Request

403

Forbidden

429

Too Many Requests

get/api/v1/principal-rate-limits
Request samples 
Response samples 
application/json
[
  • {
    • "createdBy": "string",
    • "createdDate": "2019-08-24T14:15:22Z",
    • "defaultConcurrencyPercentage": 0,
    • "defaultPercentage": 0,
    • "id": "string",
    • "lastUpdate": "2019-08-24T14:15:22Z",
    • "lastUpdatedBy": "string",
    • "orgId": "string",
    • "principalId": "string",
    • "principalType": "SSWS_TOKEN"
    }
]
Create a Principal Rate Limit
OAuth 2.0: okta.principalRateLimits.manage
Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.


Request 
Request Body schema: application/json
required
principalId
required
string
 
principalType
required
string (PrincipalType) 
 Value: "SSWS_TOKEN"  
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": "token1234",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75
}
Response samples 
application/json
{
  • "id": "abcd1234",
  • "orgId": "org1234",
  • "principalId": "token1234",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75,
  • "createdDate": "2022-05-19T20:05:32.720Z",
  • "createdBy": "user1234",
  • "lastUpdate": "2022-05-20T21:13:07.410Z",
  • "lastUpdatedBy": "user4321"
}
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:  abcd1234
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": "abcd1234",
  • "orgId": "org1234",
  • "principalId": "token1234",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75,
  • "createdDate": "2022-05-19T20:05:32.720Z",
  • "createdBy": "user1234",
  • "lastUpdate": "2022-05-20T21:13:07.410Z",
  • "lastUpdatedBy": "user4321"
}
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:  abcd1234
Request Body schema: application/json
required
principalId
required
string
 
principalType
required
string (PrincipalType) 
 Value: "SSWS_TOKEN"  
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": "token1234",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75
}
Response samples 
application/json
{
  • "id": "abcd1234",
  • "orgId": "org1234",
  • "principalId": "token1234",
  • "principalType": "SSWS_TOKEN",
  • "defaultPercentage": 50,
  • "defaultConcurrencyPercentage": 75,
  • "createdDate": "2022-05-19T20:05:32.720Z",
  • "createdBy": "user1234",
  • "lastUpdate": "2022-05-20T21:13:07.410Z",
  • "lastUpdatedBy": "user4321"
}