Create 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: <string> (see Authorizations)" \
  --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>"
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().createPolicy({
  policyName: "<string> (Human-readable name for a Policy.)",
  effect: "<EFFECT_ALLOW>" // effect field,
  condition: "<string> (The condition expression that triggers the Effect)",
  consensus: "<string> (The consensus expression that triggers the Effect)",
  notes: "<string> (Notes for a Policy.)"
});

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_POLICY_V3",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createPolicyIntentV3": {
            "policyName": "<string>",
            "effect": "<EFFECT_ALLOW>",
            "condition": "<string>",
            "consensus": "<string>",
            "notes": "<string>"
          }
        },
        "result": {
          "createPolicyResult": {
            "policyId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

POST

public

submit

create_policy

Authorizations

API Key
WebAuthn (Passkey)

string

required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

enum<string>

required

Enum options: ACTIVITY_TYPE_CREATE_POLICY_V3

string

required

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

string

required

Unique identifier for a given Organization.

object

required

The parameters object containing the specific intent data for this activity.

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

required

Notes for a Policy.

boolean

Enable to have your activity generate and return App Proofs, enabling verifiability.

Response

A successful response returns the following fields:

object

required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createPolicyIntentV3

object

required

The createPolicyIntentV3 object

Show createPolicyIntentV3 details

activity.intent.createPolicyIntentV3.policyName

string

required

Human-readable name for a Policy.

activity.intent.createPolicyIntentV3.effect

enum

required

effect fieldEnum options: EFFECT_ALLOW, EFFECT_DENY

activity.intent.createPolicyIntentV3.condition

string

The condition expression that triggers the Effect

activity.intent.createPolicyIntentV3.consensus

string

The consensus expression that triggers the Effect

activity.intent.createPolicyIntentV3.notes

string

required

Notes for a Policy.

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.

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

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: <string> (see Authorizations)" \
  --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>"
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().createPolicy({
  policyName: "<string> (Human-readable name for a Policy.)",
  effect: "<EFFECT_ALLOW>" // effect field,
  condition: "<string> (The condition expression that triggers the Effect)",
  consensus: "<string> (The consensus expression that triggers the Effect)",
  notes: "<string> (Notes for a Policy.)"
});

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_POLICY_V3",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createPolicyIntentV3": {
            "policyName": "<string>",
            "effect": "<EFFECT_ALLOW>",
            "condition": "<string>",
            "consensus": "<string>",
            "notes": "<string>"
          }
        },
        "result": {
          "createPolicyResult": {
            "policyId": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

Create policies Create private key tag

⌘I

Activities

Queries

Authorizations

Body

Response