Add or change a behaviour profile

POST

/security/behaviour

Saves by scope and name: a profile of that name at that scope is
changed (its version goes up, 200), otherwise one is created (201).
The spec is validated by the ORM's engine, extends included; give a
preset alone and the spec is that preset. A new profile reports
(records findings, applies nothing but log) unless mode: enforce.

Changing a profile that is enforcing needs a fresh step-up (or a
totp, or from the browser a password, in this body).

Checked in the controller in every mode: behaviour:write
(behaviour:team, and a role that carries it, for a team). A
verified account.

Capability: behaviour:write, checked in the route or controller in every mode. Behaviour:write (behaviour:team for a team); weakening an enforcing profile needs a step-up.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Changed

Bodyapplication/json

🟢201

🟠400

🟠401

🟠404

🟠403CapabilityMissing

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.prod-orm.io/security/behaviour' \
--header 'Content-Type: application/json' \
--data '{
    "scopeKind": "account",
    "scopeId": "string",
    "name": "string",
    "preset": "ci-service",
    "spec": {
        "property1": "string",
        "property2": "string"
    },
    "mode": "report",
    "totp": "string",
    "password": "pa$$word"
}'

Response Example

200 - Example 1

{
    "profile": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "scopeKind": "account",
        "scopeId": "string",
        "scope": {
            "kind": "account",
            "id": "string"
        },
        "name": "string",
        "preset": "string",
        "spec": {
            "property1": "string",
            "property2": "string"
        },
        "mode": "enforce",
        "version": 0,
        "createdAt": "2019-08-24T14:15:22.123Z",
        "updatedAt": "2019-08-24T14:15:22.123Z"
    },
    "created": true
}

Modified at 2026-10-05 04:04:32

The behaviour profiles that bear on you

The profile presets