Authorizations
API Key
WebAuthn (Passkey)
Cryptographically signed (stamped) request to be passed in as a header. For more info, see
here.
Cryptographically signed (stamped) request to be passed in as a header. For more info, see
here.
Body
Enum options: ACTIVITY_TYPE_CREATE_POLICIES
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
The parameters object containing the specific intent data for this activity.
An array of policy intents to be created.
parameters.policies.policyName
Human-readable name for a Policy.
parameters.policies.effect
Enum options: EFFECT_ALLOW, EFFECT_DENY
parameters.policies.condition
The condition expression that triggers the Effect
parameters.policies.consensus
The consensus expression that triggers the Effect
parameters.policies.notes
Enable to have your activity generate and return App Proofs, enabling verifiability.
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
Unique identifier for a given Activity object.
Unique identifier for a given Organization.
The intent of the activity
activity.intent.createPoliciesIntent
The createPoliciesIntent objectShow createPoliciesIntent details
activity.intent.createPoliciesIntent.policies
An array of policy intents to be created.
activity.intent.createPoliciesIntent.policies.policyName
Human-readable name for a Policy.
activity.intent.createPoliciesIntent.policies.effect
effect fieldEnum options: EFFECT_ALLOW, EFFECT_DENY
activity.intent.createPoliciesIntent.policies.condition
The condition expression that triggers the Effect
activity.intent.createPoliciesIntent.policies.consensus
The consensus expression that triggers the Effect
activity.intent.createPoliciesIntent.policies.notes
The result of the activity
activity.result.createPoliciesResult
The createPoliciesResult objectShow createPoliciesResult details
activity.result.createPoliciesResult.policyIds
A list of unique identifiers for the created policies.
activity.result.createPoliciesResult.policyIds.item
A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.
An artifact verifying a User’s action.
Whether the activity can be approved.
Whether the activity can be rejected.
The last update timestamp.
curl --request POST \
--url https://api.turnkey.com/public/v1/submit/create_policies \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header "X-Stamp: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_CREATE_POLICIES",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {
"policies": [
{
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
}
]
}
}'
{
"activity": {
"id": "<activity-id>",
"status": "ACTIVITY_STATUS_COMPLETED",
"type": "ACTIVITY_TYPE_CREATE_POLICIES",
"organizationId": "<organization-id>",
"timestampMs": "<timestamp> (e.g. 1746736509954)",
"result": {
"activity": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"createPoliciesIntent": {
"policies": [
{
"policyName": "<string>",
"effect": "<EFFECT_ALLOW>",
"condition": "<string>",
"consensus": "<string>",
"notes": "<string>"
}
]
}
},
"result": {
"createPoliciesResult": {
"policyIds": [
"<string>"
]
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}