Create a new Policy
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>"
}
}'
{
"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>"
}
}
}
}
}
}
Enum options: ACTIVITY_TYPE_CREATE_POLICY_V3
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
parameters field
Show details
A successful response returns the following fields:
The activity object containing type, intent, and result
Show activity details
The intent of the activity
Show intent details
The createPolicyIntent object
Show createPolicyIntent details
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
Show selectors details
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
effect field
Enum options: EFFECT_ALLOW
, EFFECT_DENY
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>"
}
}'
{
"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>"
}
}
}
}
}
}
Was this page helpful?
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>"
}
}'
{
"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>"
}
}
}
}
}
}
Create a new Policy
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>"
}
}'
{
"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>"
}
}
}
}
}
}
Enum options: ACTIVITY_TYPE_CREATE_POLICY_V3
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
parameters field
Show details
A successful response returns the following fields:
The activity object containing type, intent, and result
Show activity details
The intent of the activity
Show intent details
The createPolicyIntent object
Show createPolicyIntent details
A list of simple functions each including a subject, target and boolean. See Policy Engine Language section for additional details.
Show selectors details
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
effect field
Enum options: EFFECT_ALLOW
, EFFECT_DENY
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>"
}
}'
{
"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>"
}
}
}
}
}
}
Was this page helpful?
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>"
}
}'
{
"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>"
}
}
}
}
}
}