Skip to content

RiskEventApi.md

Latest commit

 

History

History
92 lines (61 loc) · 3.13 KB

RiskEventApi.md

File metadata and controls

92 lines (61 loc) · 3.13 KB

okta.RiskEventApi

All URIs are relative to https://subdomain.okta.com

Method HTTP request Description
send_risk_events POST /api/v1/risk/events/ip Send multiple risk events

send_risk_events

send_risk_events(instance)

Send multiple risk events

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.

Example

  • Api Key Authentication (apiToken):
  • OAuth Authentication (oauth2):
import okta
from okta.models.risk_event import RiskEvent
from okta.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://subdomain.okta.com
# See configuration.py for a list of all supported configuration parameters.
configuration = okta.Configuration(
    host = "https://subdomain.okta.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiToken
configuration.api_key['apiToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiToken'] = 'Bearer'

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with okta.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = okta.RiskEventApi(api_client)
    instance = [okta.RiskEvent()] # List[RiskEvent] | 

    try:
        # Send multiple risk events
        api_instance.send_risk_events(instance)
    except Exception as e:
        print("Exception when calling RiskEventApi->send_risk_events: %s\n" % e)

Parameters

Name Type Description Notes
instance List[RiskEvent]

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
403 Forbidden -
429 Too Many Requests -

[Back to top] [Back to API list] [Back to Model list] [Back to README]