okta.BehaviorApi

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

Method	HTTP request	Description
activate_behavior_detection_rule	POST /api/v1/behaviors/{behaviorId}/lifecycle/activate	Activate a behavior detection rule
create_behavior_detection_rule	POST /api/v1/behaviors	Create a behavior detection rule
deactivate_behavior_detection_rule	POST /api/v1/behaviors/{behaviorId}/lifecycle/deactivate	Deactivate a behavior detection rule
delete_behavior_detection_rule	DELETE /api/v1/behaviors/{behaviorId}	Delete a behavior detection rule
get_behavior_detection_rule	GET /api/v1/behaviors/{behaviorId}	Retrieve a behavior detection rule
list_behavior_detection_rules	GET /api/v1/behaviors	List all behavior detection rules
replace_behavior_detection_rule	PUT /api/v1/behaviors/{behaviorId}	Replace a behavior detection rule

activate_behavior_detection_rule

BehaviorRule activate_behavior_detection_rule(behavior_id)

Activate a behavior detection rule

Activates a behavior detection rule

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.behavior_rule import BehaviorRule
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.BehaviorApi(api_client)
    behavior_id = 'abcd1234' # str | ID of the Behavior Detection Rule

    try:
        # Activate a behavior detection rule
        api_response = api_instance.activate_behavior_detection_rule(behavior_id)
        print("The response of BehaviorApi->activate_behavior_detection_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BehaviorApi->activate_behavior_detection_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
behavior_id	str	ID of the Behavior Detection Rule

Return type

BehaviorRule

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

create_behavior_detection_rule

BehaviorRule create_behavior_detection_rule(rule)

Create a behavior detection rule

Creates a new behavior detection rule

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.behavior_rule import BehaviorRule
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.BehaviorApi(api_client)
    rule = okta.BehaviorRule() # BehaviorRule | 

    try:
        # Create a behavior detection rule
        api_response = api_instance.create_behavior_detection_rule(rule)
        print("The response of BehaviorApi->create_behavior_detection_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BehaviorApi->create_behavior_detection_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
rule	BehaviorRule

Return type

BehaviorRule

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Created	-
400	Bad Request	-
403	Forbidden	-
429	Too Many Requests	-

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

deactivate_behavior_detection_rule

BehaviorRule deactivate_behavior_detection_rule(behavior_id)

Deactivate a behavior detection rule

Deactivates a behavior detection rule

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.behavior_rule import BehaviorRule
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.BehaviorApi(api_client)
    behavior_id = 'abcd1234' # str | ID of the Behavior Detection Rule

    try:
        # Deactivate a behavior detection rule
        api_response = api_instance.deactivate_behavior_detection_rule(behavior_id)
        print("The response of BehaviorApi->deactivate_behavior_detection_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BehaviorApi->deactivate_behavior_detection_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
behavior_id	str	ID of the Behavior Detection Rule

Return type

BehaviorRule

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

delete_behavior_detection_rule

delete_behavior_detection_rule(behavior_id)

Delete a behavior detection rule

Deletes a Behavior Detection Rule by behaviorId

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
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.BehaviorApi(api_client)
    behavior_id = 'abcd1234' # str | ID of the Behavior Detection Rule

    try:
        # Delete a behavior detection rule
        api_instance.delete_behavior_detection_rule(behavior_id)
    except Exception as e:
        print("Exception when calling BehaviorApi->delete_behavior_detection_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
behavior_id	str	ID of the Behavior Detection Rule

Return type

void (empty response body)

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

get_behavior_detection_rule

BehaviorRule get_behavior_detection_rule(behavior_id)

Retrieve a behavior detection rule

Retrieves a Behavior Detection Rule by behaviorId

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.behavior_rule import BehaviorRule
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.BehaviorApi(api_client)
    behavior_id = 'abcd1234' # str | ID of the Behavior Detection Rule

    try:
        # Retrieve a behavior detection rule
        api_response = api_instance.get_behavior_detection_rule(behavior_id)
        print("The response of BehaviorApi->get_behavior_detection_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BehaviorApi->get_behavior_detection_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
behavior_id	str	ID of the Behavior Detection Rule

Return type

BehaviorRule

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

list_behavior_detection_rules

List[BehaviorRule] list_behavior_detection_rules()

List all behavior detection rules

Lists all behavior detection rules with pagination support

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.behavior_rule import BehaviorRule
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.BehaviorApi(api_client)

    try:
        # List all behavior detection rules
        api_response = api_instance.list_behavior_detection_rules()
        print("The response of BehaviorApi->list_behavior_detection_rules:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BehaviorApi->list_behavior_detection_rules: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[BehaviorRule]

Authorization

apiToken, oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
403	Forbidden	-
429	Too Many Requests	-

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

replace_behavior_detection_rule

BehaviorRule replace_behavior_detection_rule(behavior_id, rule)

Replace a behavior detection rule

Replaces a Behavior Detection Rule by behaviorId

Example

Api Key Authentication (apiToken):
OAuth Authentication (oauth2):

import okta
from okta.models.behavior_rule import BehaviorRule
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.BehaviorApi(api_client)
    behavior_id = 'abcd1234' # str | ID of the Behavior Detection Rule
    rule = okta.BehaviorRule() # BehaviorRule | 

    try:
        # Replace a behavior detection rule
        api_response = api_instance.replace_behavior_detection_rule(behavior_id, rule)
        print("The response of BehaviorApi->replace_behavior_detection_rule:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BehaviorApi->replace_behavior_detection_rule: %s\n" % e)

Parameters

Name	Type	Description	Notes
behavior_id	str	ID of the Behavior Detection Rule
rule	BehaviorRule

Return type

BehaviorRule

Authorization

apiToken, oauth2

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Created	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too Many Requests	-

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

FilesExpand file tree

BehaviorApi.md

Latest commit

History

BehaviorApi.md

File metadata and controls

okta.BehaviorApi

activate_behavior_detection_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_behavior_detection_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deactivate_behavior_detection_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_behavior_detection_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_behavior_detection_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_behavior_detection_rules

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

replace_behavior_detection_rule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details