Create Policy

Create a new Policy

POST

/

public

/

v1

/

submit

/

create_policy

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_POLICY_V3

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.policyName

string

required

Human-readable name for a Policy.

parameters.effect

enum<string>

required

Enum options: EFFECT_ALLOW, EFFECT_DENY

parameters.condition

string

The condition expression that triggers the Effect

parameters.consensus

string

The consensus expression that triggers the Effect

parameters.notes

string

notes field

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createPolicyIntent

object

required

The createPolicyIntent object

Show createPolicyIntent details

activity.intent.createPolicyIntent.policyName

string

required

Human-readable name for a Policy.

activity.intent.createPolicyIntent.selectors

array

required

A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.

Show selectors details

activity.intent.createPolicyIntent.selectors.subject

string

subject field

activity.intent.createPolicyIntent.selectors.operator

enum

operator field

Enum options: OPERATOR_EQUAL, OPERATOR_MORE_THAN, OPERATOR_MORE_THAN_OR_EQUAL, OPERATOR_LESS_THAN, OPERATOR_LESS_THAN_OR_EQUAL, OPERATOR_CONTAINS, OPERATOR_NOT_EQUAL, OPERATOR_IN, OPERATOR_NOT_IN, OPERATOR_CONTAINS_ONE, OPERATOR_CONTAINS_ALL

activity.intent.createPolicyIntent.selectors.target

string

target field

activity.intent.createPolicyIntent.effect

enum

required

effect field

Enum options: EFFECT_ALLOW, EFFECT_DENY

activity.intent.createPolicyIntent.notes

string

notes field

activity.result

object

required

The result of the activity

Show result details

activity.result.createPolicyResult

object

required

The createPolicyResult object

Show createPolicyResult details

activity.result.createPolicyResult.policyId

string

required

Unique identifier for a given Policy.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_policy \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_POLICY_V3",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "policyName": "<string>",
        "effect": "<EFFECT_ALLOW>",
        "condition": "<string>",
        "consensus": "<string>",
        "notes": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_POLICY_V3",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createPolicyIntent": {
            "policyName": "<string>",
            "selectors": [
              {
                "subject": "<string>",
                "operator": "<OPERATOR_EQUAL>",
                "target": "<string>"
              }
            ],
            "effect": "<EFFECT_ALLOW>",
            "notes": "<string>"
          }
        },
        "result": {
          "createPolicyResult": {
            "policyId": "<string>"
          }
        }
      }
    }
  }
}