The Behavior Rules API provides operations to manage the behavior detection rules for your organization.
okta.behaviors.read
Lists all behavior detection rules with pagination support
OK
Forbidden
Too Many Requests
[- {
- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "ANOMALOUS_DEVICE",
- "_link": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
}
}
]
okta.behaviors.manage
Creates a new behavior detection rule
Created
Bad Request
Forbidden
Too Many Requests
{- "name": "My Behavior Rule",
- "type": "VELOCITY"
}
{- "id": "abcd1234",
- "name": "My Behavior Rule",
- "type": "VELOCITY",
- "settings": {
- "velocityKph": 805
}, - "status": "ACTIVE",
- "created": "2021-11-09T20:38:10.000Z",
- "lastUpdated": "2021-11-11T20:38:10.000Z",
- "_link": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "POST",
- "PUT",
- "DELETE"
]
}
}
}
}
okta.behaviors.read
Retrieves a Behavior Detection Rule by behaviorId
OK
Forbidden
Not Found
Too Many Requests
{- "created": "2019-08-24T14:15:22Z",
- "id": "string",
- "lastUpdated": "2019-08-24T14:15:22Z",
- "name": "string",
- "status": "ACTIVE",
- "type": "ANOMALOUS_LOCATION",
- "_link": {
- "self": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "templated": true,
- "type": "string"
}
}, - "settings": {
- "maxEventsUsedForEvaluation": 20,
- "minEventsNeededForEvaluation": 0,
- "granularity": "CITY",
- "radiusKilometers": 0
}
}
okta.behaviors.manage
Replaces a Behavior Detection Rule by behaviorId
name required | string <= 128 characters | ||||||||
type required | string (BehaviorRuleType) | ||||||||
status | string (LifecycleStatus) Enum: "ACTIVE" "INACTIVE" | ||||||||
object (BehaviorRuleSettingsAnomalousLocation) | |||||||||
|
Created
Bad Request
Forbidden
Not Found
Too Many Requests
{- "name": "My Behavior Rule",
- "type": "VELOCITY"
}
{- "id": "abcd1234",
- "name": "My Behavior Rule",
- "type": "VELOCITY",
- "settings": {
- "velocityKph": 805
}, - "status": "ACTIVE",
- "created": "2021-11-09T20:38:10.000Z",
- "lastUpdated": "2021-11-11T20:38:10.000Z",
- "_link": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "POST",
- "PUT",
- "DELETE"
]
}
}
}
}
okta.behaviors.manage
Deletes a Behavior Detection Rule by behaviorId
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
okta.behaviors.manage
Activates a behavior detection rule
Success
Forbidden
Not Found
Too Many Requests
{- "id": "abcd1234",
- "name": "My Behavior Rule",
- "type": "VELOCITY",
- "settings": {
- "velocityKph": 805
}, - "status": "ACTIVE",
- "created": "2021-11-09T20:38:10.000Z",
- "lastUpdated": "2021-11-11T20:38:10.000Z",
- "_link": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "POST",
- "PUT",
- "DELETE"
]
}
}
}
}
okta.behaviors.manage
Deactivates a behavior detection rule
Success
Forbidden
Not Found
Too Many Requests
{- "id": "abcd1234",
- "name": "My Behavior Rule",
- "type": "VELOCITY",
- "settings": {
- "velocityKph": 805
}, - "status": "ACTIVE",
- "created": "2021-11-09T20:38:10.000Z",
- "lastUpdated": "2021-11-11T20:38:10.000Z",
- "_link": {
- "self": {
- "hints": {
- "allow": [
- "GET",
- "POST",
- "PUT",
- "DELETE"
]
}
}
}
}