List Policies - Turnkey

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

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

POST

public

query

list_policies

Authorizations

X-Stamp

string

header

required

Body

organizationId

string

required

Unique identifier for a given Organization.

Response

A successful response returns the following fields:

policies

array

required

A list of Policies.

Show policies details

policies.policyId

string

required

Unique identifier for a given Policy.

policies.policyName

string

required

Human-readable name for a Policy.

policies.effect

enum

required

effect field

Enum options: EFFECT_ALLOW, EFFECT_DENY

policies.createdAt

object

required

createdAt field

Show createdAt details

policies.createdAt.seconds

string

required

seconds field

policies.createdAt.nanos

string

required

nanos field

policies.updatedAt

object

required

updatedAt field

Show updatedAt details

policies.updatedAt.seconds

string

required

seconds field

policies.updatedAt.nanos

string

required

nanos field

policies.notes

string

required

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

policies.consensus

string

required

A consensus expression that evalutes to true or false.

policies.condition

string

required

A condition expression that evalutes to true or false.

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

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

List Activities List Private Key Tags

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

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

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

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

POST

public

query

list_policies

Authorizations

X-Stamp

string

header

required

Body

organizationId

string

required

Unique identifier for a given Organization.

Response

A successful response returns the following fields:

policies

array

required

A list of Policies.

Show policies details

policies.policyId

string

required

Unique identifier for a given Policy.

policies.policyName

string

required

Human-readable name for a Policy.

policies.effect

enum

required

effect field

Enum options: EFFECT_ALLOW, EFFECT_DENY

policies.createdAt

object

required

createdAt field

Show createdAt details

policies.createdAt.seconds

string

required

seconds field

policies.createdAt.nanos

string

required

nanos field

policies.updatedAt

object

required

updatedAt field

Show updatedAt details

policies.updatedAt.seconds

string

required

seconds field

policies.updatedAt.nanos

string

required

nanos field

policies.notes

string

required

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

policies.consensus

string

required

A consensus expression that evalutes to true or false.

policies.condition

string

required

A condition expression that evalutes to true or false.

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

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

List Activities List Private Key Tags

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

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

Authorizations

Body

Response

Activities

Queries

Authorizations

Body

Response