POST /api/v1/principal-rate-limits
Creates a new principal rate limit entity. Okta only allows one principal rate limit entity per org and principal.
Servers
- https://{yourOktaDomain}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
The unique identifier of the principle rate limit entity |
defaultPercentage |
Integer | No |
The default percentage of a given rate limit threshold that the owning principal can consume |
orgId |
String | No |
The unique identifier of the Okta org |
principalType |
String | Yes |
The type of principal, either an API token or an OAuth 2.0 app Valid values:
|
lastUpdate |
String | No |
The date and time the principle rate limit entity was last updated |
lastUpdatedBy |
String | No |
The Okta user ID of the user who last updated the principle rate limit entity |
defaultConcurrencyPercentage |
Integer | No |
The default percentage of a given concurrency limit threshold that the owning principal can consume |
principalId |
String | Yes |
The unique identifier of the principal. This is the ID of the API token or OAuth 2.0 app. |
createdBy |
String | No |
The Okta user ID of the user who created the principle rate limit entity |
createdDate |
String | No |
The date and time the principle rate limit entity was created |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.