behavior_detection_rules

Creates, updates, deletes, gets or lists a behavior_detection_rules resource.

Overview

Name	behavior_detection_rules
Type	Resource
Id	okta.behaviors.behavior_detection_rules

Fields

The following fields are returned by SELECT queries:

list_behavior_detection_rules

Name	Datatype	Description
id	string	ID of the Behavior Detection Rule
name	string	Name of the Behavior Detection Rule
_link	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
created	string	Timestamp when the Behavior Detection Rule was created
lastUpdated	string	Timestamp when the Behavior Detection Rule was last modified
status	string
type	string

get_behavior_detection_rule

Name	Datatype	Description
id	string	ID of the Behavior Detection Rule
name	string	Name of the Behavior Detection Rule
_link	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
created	string	Timestamp when the Behavior Detection Rule was created
lastUpdated	string	Timestamp when the Behavior Detection Rule was last modified
status	string
type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_behavior_detection_rules	select	subdomain		Lists all behavior detection rules with pagination support
get_behavior_detection_rule	select	subdomain		Retrieves a Behavior Detection Rule by behaviorId
create_behavior_detection_rule	insert	subdomain, data__name, data__type		Creates a new behavior detection rule
replace_behavior_detection_rule	replace	subdomain, data__name, data__type		Replaces a Behavior Detection Rule by behaviorId
delete_behavior_detection_rule	delete	subdomain		Deletes a Behavior Detection Rule by behaviorId
activate_behavior_detection_rule	exec	subdomain		Activates a behavior detection rule
deactivate_behavior_detection_rule	exec	subdomain		Deactivates a behavior detection rule

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

list_behavior_detection_rules

Lists all behavior detection rules with pagination support

SELECT
id,
name,
_link,
created,
lastUpdated,
status,
type
FROM okta.behaviors.behavior_detection_rules
WHERE subdomain = '{{ subdomain }}' -- required;

get_behavior_detection_rule

Retrieves a Behavior Detection Rule by behaviorId

SELECT
id,
name,
_link,
created,
lastUpdated,
status,
type
FROM okta.behaviors.behavior_detection_rules
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_behavior_detection_rule

Creates a new behavior detection rule

INSERT INTO okta.behaviors.behavior_detection_rules (
data__name,
data__status,
data__type,
subdomain
)
SELECT 
'{{ name }}' --required,
'{{ status }}',
'{{ type }}' --required,
'{{ subdomain }}'
RETURNING
id,
name,
_link,
created,
lastUpdated,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: behavior_detection_rules
  props:
    - name: subdomain
      value: string
      description: Required parameter for the behavior_detection_rules resource.
    - name: name
      value: string
      description: >
        Name of the Behavior Detection Rule
        
    - name: status
      value: string
      valid_values: ['ACTIVE', 'INACTIVE']
    - name: type
      value: string
      valid_values: ['ANOMALOUS_DEVICE', 'ANOMALOUS_IP', 'ANOMALOUS_LOCATION', 'VELOCITY']

REPLACE examples

replace_behavior_detection_rule

Replaces a Behavior Detection Rule by behaviorId

REPLACE okta.behaviors.behavior_detection_rules
SET 
data__name = '{{ name }}',
data__status = '{{ status }}',
data__type = '{{ type }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__name = '{{ name }}' --required
AND data__type = '{{ type }}' --required
RETURNING
id,
name,
_link,
created,
lastUpdated,
status,
type;

DELETE examples

delete_behavior_detection_rule

Deletes a Behavior Detection Rule by behaviorId

DELETE FROM okta.behaviors.behavior_detection_rules
WHERE subdomain = '{{ subdomain }}' --required;

Lifecycle Methods

activate_behavior_detection_rule

Activates a behavior detection rule

EXEC okta.behaviors.behavior_detection_rules.activate_behavior_detection_rule 
@subdomain='{{ subdomain }}' --required;

deactivate_behavior_detection_rule

Deactivates a behavior detection rule

EXEC okta.behaviors.behavior_detection_rules.deactivate_behavior_detection_rule 
@subdomain='{{ subdomain }}' --required;