Create a policy module
curl --request POST \
--url https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "vendor-allowlist",
"description": "<string>",
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_name": "<string>",
"action_types": [
"<string>"
],
"allow": [
"<string>"
],
"max_cents": 123,
"window_seconds": 2,
"max_actions": 2,
"above_cents": 123,
"effect": "deny",
"when": {
"all_of": "<array>",
"any_of": "<array>",
"not": "<unknown>",
"field": "metadata.preapproved",
"value": "<unknown>"
}
}
]
}
'import requests
url = "https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules"
payload = {
"name": "vendor-allowlist",
"description": "<string>",
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_name": "<string>",
"action_types": ["<string>"],
"allow": ["<string>"],
"max_cents": 123,
"window_seconds": 2,
"max_actions": 2,
"above_cents": 123,
"effect": "deny",
"when": {
"all_of": "<array>",
"any_of": "<array>",
"not": "<unknown>",
"field": "metadata.preapproved",
"value": "<unknown>"
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'vendor-allowlist',
description: '<string>',
rules: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
rule_name: '<string>',
action_types: ['<string>'],
allow: ['<string>'],
max_cents: 123,
window_seconds: 2,
max_actions: 2,
above_cents: 123,
effect: 'deny',
when: {
all_of: '<array>',
any_of: '<array>',
not: '<unknown>',
field: 'metadata.preapproved',
value: '<unknown>'
}
}
]
})
};
fetch('https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'vendor-allowlist',
'description' => '<string>',
'rules' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'rule_name' => '<string>',
'action_types' => [
'<string>'
],
'allow' => [
'<string>'
],
'max_cents' => 123,
'window_seconds' => 2,
'max_actions' => 2,
'above_cents' => 123,
'effect' => 'deny',
'when' => [
'all_of' => '<array>',
'any_of' => '<array>',
'not' => '<unknown>',
'field' => 'metadata.preapproved',
'value' => '<unknown>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules"
payload := strings.NewReader("{\n \"name\": \"vendor-allowlist\",\n \"description\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rule_name\": \"<string>\",\n \"action_types\": [\n \"<string>\"\n ],\n \"allow\": [\n \"<string>\"\n ],\n \"max_cents\": 123,\n \"window_seconds\": 2,\n \"max_actions\": 2,\n \"above_cents\": 123,\n \"effect\": \"deny\",\n \"when\": {\n \"all_of\": \"<array>\",\n \"any_of\": \"<array>\",\n \"not\": \"<unknown>\",\n \"field\": \"metadata.preapproved\",\n \"value\": \"<unknown>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"vendor-allowlist\",\n \"description\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rule_name\": \"<string>\",\n \"action_types\": [\n \"<string>\"\n ],\n \"allow\": [\n \"<string>\"\n ],\n \"max_cents\": 123,\n \"window_seconds\": 2,\n \"max_actions\": 2,\n \"above_cents\": 123,\n \"effect\": \"deny\",\n \"when\": {\n \"all_of\": \"<array>\",\n \"any_of\": \"<array>\",\n \"not\": \"<unknown>\",\n \"field\": \"metadata.preapproved\",\n \"value\": \"<unknown>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"vendor-allowlist\",\n \"description\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rule_name\": \"<string>\",\n \"action_types\": [\n \"<string>\"\n ],\n \"allow\": [\n \"<string>\"\n ],\n \"max_cents\": 123,\n \"window_seconds\": 2,\n \"max_actions\": 2,\n \"above_cents\": 123,\n \"effect\": \"deny\",\n \"when\": {\n \"all_of\": \"<array>\",\n \"any_of\": \"<array>\",\n \"not\": \"<unknown>\",\n \"field\": \"metadata.preapproved\",\n \"value\": \"<unknown>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"rules": [
{
"kind": "action_allowlist",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_name": "<string>",
"action_types": [
"<string>"
],
"allow": [
"<string>"
],
"max_cents": 123,
"window_seconds": 2,
"max_actions": 2,
"above_cents": 123,
"effect": "deny",
"when": {
"all_of": "<array>",
"any_of": "<array>",
"not": "<unknown>",
"field": "metadata.preapproved",
"operator": "eq",
"value": "<unknown>"
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "Insufficient role",
"code": "insufficient_role"
}
}{
"error": {
"message": "<string>",
"code": "runtime_key_required"
}
}Create a policy module
Requires manage_policy.
A module is a named rule set scoped to the workspace. Policies import it by name and its rules compile in ahead of their own.
Editing a module changes every policy that imports it. Modules cannot import other modules, so composition is one level deep and cannot cycle.
POST
/
control
/
v1
/
workspaces
/
{workspace_slug}
/
policy_modules
Create a policy module
curl --request POST \
--url https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "vendor-allowlist",
"description": "<string>",
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_name": "<string>",
"action_types": [
"<string>"
],
"allow": [
"<string>"
],
"max_cents": 123,
"window_seconds": 2,
"max_actions": 2,
"above_cents": 123,
"effect": "deny",
"when": {
"all_of": "<array>",
"any_of": "<array>",
"not": "<unknown>",
"field": "metadata.preapproved",
"value": "<unknown>"
}
}
]
}
'import requests
url = "https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules"
payload = {
"name": "vendor-allowlist",
"description": "<string>",
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_name": "<string>",
"action_types": ["<string>"],
"allow": ["<string>"],
"max_cents": 123,
"window_seconds": 2,
"max_actions": 2,
"above_cents": 123,
"effect": "deny",
"when": {
"all_of": "<array>",
"any_of": "<array>",
"not": "<unknown>",
"field": "metadata.preapproved",
"value": "<unknown>"
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'vendor-allowlist',
description: '<string>',
rules: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
rule_name: '<string>',
action_types: ['<string>'],
allow: ['<string>'],
max_cents: 123,
window_seconds: 2,
max_actions: 2,
above_cents: 123,
effect: 'deny',
when: {
all_of: '<array>',
any_of: '<array>',
not: '<unknown>',
field: 'metadata.preapproved',
value: '<unknown>'
}
}
]
})
};
fetch('https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'vendor-allowlist',
'description' => '<string>',
'rules' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'rule_name' => '<string>',
'action_types' => [
'<string>'
],
'allow' => [
'<string>'
],
'max_cents' => 123,
'window_seconds' => 2,
'max_actions' => 2,
'above_cents' => 123,
'effect' => 'deny',
'when' => [
'all_of' => '<array>',
'any_of' => '<array>',
'not' => '<unknown>',
'field' => 'metadata.preapproved',
'value' => '<unknown>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules"
payload := strings.NewReader("{\n \"name\": \"vendor-allowlist\",\n \"description\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rule_name\": \"<string>\",\n \"action_types\": [\n \"<string>\"\n ],\n \"allow\": [\n \"<string>\"\n ],\n \"max_cents\": 123,\n \"window_seconds\": 2,\n \"max_actions\": 2,\n \"above_cents\": 123,\n \"effect\": \"deny\",\n \"when\": {\n \"all_of\": \"<array>\",\n \"any_of\": \"<array>\",\n \"not\": \"<unknown>\",\n \"field\": \"metadata.preapproved\",\n \"value\": \"<unknown>\"\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"vendor-allowlist\",\n \"description\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rule_name\": \"<string>\",\n \"action_types\": [\n \"<string>\"\n ],\n \"allow\": [\n \"<string>\"\n ],\n \"max_cents\": 123,\n \"window_seconds\": 2,\n \"max_actions\": 2,\n \"above_cents\": 123,\n \"effect\": \"deny\",\n \"when\": {\n \"all_of\": \"<array>\",\n \"any_of\": \"<array>\",\n \"not\": \"<unknown>\",\n \"field\": \"metadata.preapproved\",\n \"value\": \"<unknown>\"\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kordio.io/control/v1/workspaces/{workspace_slug}/policy_modules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"vendor-allowlist\",\n \"description\": \"<string>\",\n \"rules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"rule_name\": \"<string>\",\n \"action_types\": [\n \"<string>\"\n ],\n \"allow\": [\n \"<string>\"\n ],\n \"max_cents\": 123,\n \"window_seconds\": 2,\n \"max_actions\": 2,\n \"above_cents\": 123,\n \"effect\": \"deny\",\n \"when\": {\n \"all_of\": \"<array>\",\n \"any_of\": \"<array>\",\n \"not\": \"<unknown>\",\n \"field\": \"metadata.preapproved\",\n \"value\": \"<unknown>\"\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"rules": [
{
"kind": "action_allowlist",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_name": "<string>",
"action_types": [
"<string>"
],
"allow": [
"<string>"
],
"max_cents": 123,
"window_seconds": 2,
"max_actions": 2,
"above_cents": 123,
"effect": "deny",
"when": {
"all_of": "<array>",
"any_of": "<array>",
"not": "<unknown>",
"field": "metadata.preapproved",
"operator": "eq",
"value": "<unknown>"
}
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "Insufficient role",
"code": "insufficient_role"
}
}{
"error": {
"message": "<string>",
"code": "runtime_key_required"
}
}Authorizations
An identity bearer token for a person or your backend. Capabilities are per member, per workspace. This credential can manage the workspace and can never authorize an action as an agent.
Path Parameters
Body
application/json
Response
The module.
Show child attributes
Show child attributes