Get Policy

Get details about a Policy

POST

/

public

/

v1

/

query

/

get_policy

Authorizations

API Key

X-Stamp

string

header

required

Body

organizationId · string · required

Unique identifier for a given Organization.

policyId · string · required

Unique identifier for a given Policy.

Response

A successful response returns the following fields:

policy · object · required

policy field

Show policy details

policy.policyId

string

required

Unique identifier for a given Policy.

policy.policyName

string

required

Human-readable name for a Policy.

policy.effect

enum

required

effect field

Enum options: EFFECT_ALLOW, EFFECT_DENY

policy.createdAt

object

required

createdAt field

Show createdAt details

policy.createdAt.seconds

string

required

seconds field

policy.createdAt.nanos

string

required

nanos field

policy.updatedAt

object

required

updatedAt field

Show updatedAt details

policy.updatedAt.seconds

string

required

seconds field

policy.updatedAt.nanos

string

required

nanos field

policy.notes

string

required

Human-readable notes added by a User to describe a particular policy.

policy.consensus

string

required

A consensus expression that evalutes to true or false.

policy.condition

string

required

A condition expression that evalutes to true or false.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_policy \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "policyId": "<string>"
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "policy": {
        "policyId": "<string>",
        "policyName": "<string>",
        "effect": "<EFFECT_ALLOW>",
        "createdAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "updatedAt": {
          "seconds": "<string>",
          "nanos": "<string>"
        },
        "notes": "<string>",
        "consensus": "<string>",
        "condition": "<string>"
      }
    }
  }
}