POST /api/v1/risk/events/ip

Sends multiple IP risk events to Okta. This request is used by a third-party risk provider to send IP risk events to Okta. The third-party risk provider needs to be registered with Okta before they can send events to Okta. See Risk Providers. This API has a rate limit of 30 requests per minute. You can include multiple risk events (up to a maximum of 20 events) in a single payload to reduce the number of API calls. Prioritize sending high risk signals if you have a burst of signals to send that would exceed the maximum request limits.

Servers

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
[] Array Yes
[].timestamp String No

Timestamp of when the event is produced (expressed as a UTC time zone using ISO 8601 format: yyyy-MM-ddTHH:mm:ss.SSSZ)

[].expiresAt String No

Timestamp at which the event expires (expressed as a UTC time zone using ISO 8601 format: yyyy-MM-ddTHH:mm:ss.SSSZ). If this optional field is not included, Okta automatically expires the event 24 hours after the event is consumed.

[].subjects[] Array Yes

List of Risk Event Subjects

[].subjects[].message String No

Additional reasons for the risk level of the IP

[].subjects[].ip String Yes

The risk event subject IP address (either an IPv4 or IPv6 address)

[].subjects[].riskLevel String Yes

The risk level associated with the IP

Possible values:

  • "LOW"
  • "HIGH"
  • "MEDIUM"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.