Create Policies

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: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_POLICIES",
    "timestampMs": "<string> (e.g., 1745474677465)",
    "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., 1745474677465)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createPoliciesIntent": {
            "policies": [
              {
                "policyName": "<string>",
                "effect": "<EFFECT_ALLOW>",
                "condition": "<string>",
                "consensus": "<string>",
                "notes": "<string>"
              }
            ]
          }
        },
        "result": {
          "createPoliciesResult": {
            "policyIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}

POST

public

submit

create_policies

Authorizations

X-Stamp

string

header

required

Body

type

enum<string>

required

Enum options: ACTIVITY_TYPE_CREATE_POLICIES

timestampMs

string

required

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

organizationId

string

required

Unique identifier for a given Organization.

parameters

object

required

parameters field

Show details

parameters.policies

array

required

An array of policy intents to be created.

Show item details

parameters.policies.policyName

string

required

Human-readable name for a Policy.

parameters.policies.effect

enum<string>

required

Enum options: EFFECT_ALLOW, EFFECT_DENY

parameters.policies.condition

string

The condition expression that triggers the Effect

parameters.policies.consensus

string

The consensus expression that triggers the Effect

parameters.policies.notes

string

notes field

Response

A successful response returns the following fields:

activity

object

required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createPoliciesIntent

object

required

The createPoliciesIntent object

Show createPoliciesIntent details

activity.intent.createPoliciesIntent.policies

array

required

An array of policy intents to be created.

Show policies details

activity.intent.createPoliciesIntent.policies.policyName

string

required

Human-readable name for a Policy.

activity.intent.createPoliciesIntent.policies.effect

enum

required

effect field

Enum options: EFFECT_ALLOW, EFFECT_DENY

activity.intent.createPoliciesIntent.policies.condition

string

The condition expression that triggers the Effect

activity.intent.createPoliciesIntent.policies.consensus

string

The consensus expression that triggers the Effect

activity.intent.createPoliciesIntent.policies.notes

string

notes field

activity.result

object

required

The result of the activity

Show result details

activity.result.createPoliciesResult

object

required

The createPoliciesResult object

Show createPoliciesResult details

activity.result.createPoliciesResult.policyIds

array

required

A list of unique identifiers for the created policies.

Show policyIds details

activity.result.createPoliciesResult.policyIds.item

string

required

item field

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: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_POLICIES",
    "timestampMs": "<string> (e.g., 1745474677465)",
    "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., 1745474677465)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createPoliciesIntent": {
            "policies": [
              {
                "policyName": "<string>",
                "effect": "<EFFECT_ALLOW>",
                "condition": "<string>",
                "consensus": "<string>",
                "notes": "<string>"
              }
            ]
          }
        },
        "result": {
          "createPoliciesResult": {
            "policyIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}

Create Oauth Providers Create Policy

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: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_POLICIES",
    "timestampMs": "<string> (e.g., 1745474677465)",
    "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., 1745474677465)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createPoliciesIntent": {
            "policies": [
              {
                "policyName": "<string>",
                "effect": "<EFFECT_ALLOW>",
                "condition": "<string>",
                "consensus": "<string>",
                "notes": "<string>"
              }
            ]
          }
        },
        "result": {
          "createPoliciesResult": {
            "policyIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}

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: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_POLICIES",
    "timestampMs": "<string> (e.g., 1745474677465)",
    "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., 1745474677465)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createPoliciesIntent": {
            "policies": [
              {
                "policyName": "<string>",
                "effect": "<EFFECT_ALLOW>",
                "condition": "<string>",
                "consensus": "<string>",
                "notes": "<string>"
              }
            ]
          }
        },
        "result": {
          "createPoliciesResult": {
            "policyIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}

POST

public

submit

create_policies

Authorizations

X-Stamp

string

header

required

Body

type

enum<string>

required

Enum options: ACTIVITY_TYPE_CREATE_POLICIES

timestampMs

string

required

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

organizationId

string

required

Unique identifier for a given Organization.

parameters

object

required

parameters field

Show details

parameters.policies

array

required

An array of policy intents to be created.

Show item details

parameters.policies.policyName

string

required

Human-readable name for a Policy.

parameters.policies.effect

enum<string>

required

Enum options: EFFECT_ALLOW, EFFECT_DENY

parameters.policies.condition

string

The condition expression that triggers the Effect

parameters.policies.consensus

string

The consensus expression that triggers the Effect

parameters.policies.notes

string

notes field

Response

A successful response returns the following fields:

activity

object

required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createPoliciesIntent

object

required

The createPoliciesIntent object

Show createPoliciesIntent details

activity.intent.createPoliciesIntent.policies

array

required

An array of policy intents to be created.

Show policies details

activity.intent.createPoliciesIntent.policies.policyName

string

required

Human-readable name for a Policy.

activity.intent.createPoliciesIntent.policies.effect

enum

required

effect field

Enum options: EFFECT_ALLOW, EFFECT_DENY

activity.intent.createPoliciesIntent.policies.condition

string

The condition expression that triggers the Effect

activity.intent.createPoliciesIntent.policies.consensus

string

The consensus expression that triggers the Effect

activity.intent.createPoliciesIntent.policies.notes

string

notes field

activity.result

object

required

The result of the activity

Show result details

activity.result.createPoliciesResult

object

required

The createPoliciesResult object

Show createPoliciesResult details

activity.result.createPoliciesResult.policyIds

array

required

A list of unique identifiers for the created policies.

Show policyIds details

activity.result.createPoliciesResult.policyIds.item

string

required

item field

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: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_POLICIES",
    "timestampMs": "<string> (e.g., 1745474677465)",
    "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., 1745474677465)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createPoliciesIntent": {
            "policies": [
              {
                "policyName": "<string>",
                "effect": "<EFFECT_ALLOW>",
                "condition": "<string>",
                "consensus": "<string>",
                "notes": "<string>"
              }
            ]
          }
        },
        "result": {
          "createPoliciesResult": {
            "policyIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}

Create Oauth Providers Create Policy

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: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_POLICIES",
    "timestampMs": "<string> (e.g., 1745474677465)",
    "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., 1745474677465)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createPoliciesIntent": {
            "policies": [
              {
                "policyName": "<string>",
                "effect": "<EFFECT_ALLOW>",
                "condition": "<string>",
                "consensus": "<string>",
                "notes": "<string>"
              }
            ]
          }
        },
        "result": {
          "createPoliciesResult": {
            "policyIds": [
              "<string_element>"
            ]
          }
        }
      }
    }
  }
}

Create Policies

Authorizations

Body

Response

Activities

Queries

Create Policies

Authorizations

Body

Response