Create policy

Create a new policy within an organization and return the persisted record

posthttps://localhost:10001/api/v1/organizations/{orgId}/policies

bash

curl --request POST \
  --url 'https://localhost:10001/api/v1/organizations/{orgId}/policies' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"controls":[{"citations":[{"title":"string","url":"string"}],"controlCode":"string","description":"string","title":"string"}],"description":"string","iconUrl":"string","name":"string","type":"Risk Management","version":"string"}'

javascript

const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/policies", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "controls": [
      {
        "citations": [
          {
            "title": "string",
            "url": "string"
          }
        ],
        "controlCode": "string",
        "description": "string",
        "title": "string"
      }
    ],
    "description": "string",
    "iconUrl": "string",
    "name": "string",
    "type": "Risk Management",
    "version": "string"
  })
});

const data = await response.json();

typescript

interface Policy {
  cid?: string;
  controls?: Record<string, unknown>[];
  createdAt?: string;
  description?: string;
  iconUrl?: string;
  id?: number;
  name?: string;
  organizationId?: number;
  slug?: string;
  type?: Record<string, unknown>;
  updatedAt?: string;
  version?: string;
}

const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/policies", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "controls": [
      {
        "citations": [
          {
            "title": "string",
            "url": "string"
          }
        ],
        "controlCode": "string",
        "description": "string",
        "title": "string"
      }
    ],
    "description": "string",
    "iconUrl": "string",
    "name": "string",
    "type": "Risk Management",
    "version": "string"
  })
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: Policy = await response.json();

python

import requests

response = requests.post(
    "https://localhost:10001/api/v1/organizations/{orgId}/policies",
    headers={
        "Authorization": "Bearer <token>",
        "Content-Type": "application/json",
    },
    json={
        "controls": [
            {
                "citations": [
                    {
                        "title": "string",
                        "url": "string",
                    },
                ],
                "controlCode": "string",
                "description": "string",
                "title": "string",
            },
        ],
        "description": "string",
        "iconUrl": "string",
        "name": "string",
        "type": "Risk Management",
        "version": "string",
    },
)
response.raise_for_status()
print(response.json())

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "controls": [
	    {
	      "citations": [
	        {
	          "title": "string",
	          "url": "string"
	        }
	      ],
	      "controlCode": "string",
	      "description": "string",
	      "title": "string"
	    }
	  ],
	  "description": "string",
	  "iconUrl": "string",
	  "name": "string",
	  "type": "Risk Management",
	  "version": "string"
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://localhost:10001/api/v1/organizations/{orgId}/policies", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}

java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:10001/api/v1/organizations/{orgId}/policies"))
            .header("Authorization", "Bearer <token>")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString("""
                {
                  "controls": [
                    {
                      "citations": [
                        {
                          "title": "string",
                          "url": "string"
                        }
                      ],
                      "controlCode": "string",
                      "description": "string",
                      "title": "string"
                    }
                  ],
                  "description": "string",
                  "iconUrl": "string",
                  "name": "string",
                  "type": "Risk Management",
                  "version": "string"
                }
                """))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

csharp

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://localhost:10001/api/v1/organizations/{orgId}/policies");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
    {
      "controls": [
        {
          "citations": [
            {
              "title": "string",
              "url": "string"
            }
          ],
          "controlCode": "string",
          "description": "string",
          "title": "string"
        }
      ],
      "description": "string",
      "iconUrl": "string",
      "name": "string",
      "type": "Risk Management",
      "version": "string"
    }
    """, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

php

<?php

$ch = curl_init('https://localhost:10001/api/v1/organizations/{orgId}/policies');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => <<<'JSON'
    {
      "controls": [
        {
          "citations": [
            {
              "title": "string",
              "url": "string"
            }
          ],
          "controlCode": "string",
          "description": "string",
          "title": "string"
        }
      ],
      "description": "string",
      "iconUrl": "string",
      "name": "string",
      "type": "Risk Management",
      "version": "string"
    }
    JSON,
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;

ruby

require "net/http"

uri = URI("https://localhost:10001/api/v1/organizations/{orgId}/policies")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
  {
    "controls": [
      {
        "citations": [
          {
            "title": "string",
            "url": "string"
          }
        ],
        "controlCode": "string",
        "description": "string",
        "title": "string"
      }
    ],
    "description": "string",
    "iconUrl": "string",
    "name": "string",
    "type": "Risk Management",
    "version": "string"
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"

rust

// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .post("https://localhost:10001/api/v1/organizations/{orgId}/policies")
        .header("Authorization", "Bearer <token>")
        .json(&json!({
            "controls": [
                {
                    "citations": [
                        {
                            "title": "string",
                            "url": "string"
                        }
                    ],
                    "controlCode": "string",
                    "description": "string",
                    "title": "string"
                }
            ],
            "description": "string",
            "iconUrl": "string",
            "name": "string",
            "type": "Risk Management",
            "version": "string"
        }))
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.

Parameters

Path parameters

Name	Type	Description
`orgId` required	`string`	Organization ID or UUID (urn:uuid optional)

Request bodyrequired

Policy object

application/json

controlshandlers.CreateControlRequest[]required
At least one control is required
Show properties
Array of handlers.CreateControlRequest
- citationscore.Citation[]
  Up to 20
  Show properties
  Array of core.Citation
  titlestring
  Up to 255 characters; trimmed
  urlstring
  An absolute http or https URL with a hostname, up to 2048 bytes; trimmed
- controlCodestringrequired
  Alphanumeric, . and -; upper-cased
- descriptionstringrequired
- titlestringrequired
descriptionstringrequired
iconUrlstring
namestringrequired
typecore.PolicyTyperequired
One ofRisk ManagementInternalRegulatoryCustom
versionstringrequired
SemVer with no leading "v", e.g. 1.2.3

Examplejson

{
  "controls": [
    {
      "citations": [
        {
          "title": "string",
          "url": "string"
        }
      ],
      "controlCode": "string",
      "description": "string",
      "title": "string"
    }
  ],
  "description": "string",
  "iconUrl": "string",
  "name": "string",
  "type": "Risk Management",
  "version": "string"
}

Responses

201Created policy

application/json

cidstringread-only
Assigned by the Integrity Service at creation
controlscore.Control[]
Present on read, ignored on update
Show properties
Array of core.Control
- cidstringread-only
  Assigned by the Integrity Service at creation
- citationscore.Citation[]
  Up to 20
  Show properties
  Array of core.Citation
  titlestring
  Up to 255 characters; trimmed
  urlstring
  An absolute http or https URL with a hostname, up to 2048 bytes; trimmed
- controlCodestring
  Alphanumeric, . and -; upper-cased
- createdAtstring<date-time>read-only
- descriptionstring
- idintegerread-only
- policyIdintegerread-only
  Assigned from the parent policy
- titlestring
- updatedAtstring<date-time>read-only
createdAtstring<date-time>read-only
descriptionstring
iconUrlstring
idintegerread-only
namestring
organizationIdintegerread-only
Taken from the path on create
slugstringread-only
Derived from name
typeobject
See PolicyType for values
Show properties
object — See PolicyType for values
updatedAtstring<date-time>read-only
versionstring

Examplejson

{
  "cid": "string",
  "controls": [
    {
      "citations": [
        {
          "title": "string",
          "url": "string"
        }
      ],
      "controlCode": "string",
      "description": "string",
      "title": "string"
    }
  ],
  "createdAt": "2025-01-01T00:00:00Z",
  "description": "string",
  "iconUrl": "string",
  "id": 0,
  "name": "string",
  "organizationId": 0,
  "slug": "string",
  "type": {},
  "updatedAt": "2025-01-01T00:00:00Z",
  "version": "string"
}

400Bad request - Invalid organization ID or request body

application/json

errorstring

Examplejson

{
  "error": "Invalid request body"
}

401Unauthorized - Authentication required

application/json

errorstring

Examplejson

{
  "error": "Invalid request body"
}

403Forbidden - No organization access or insufficient permissions

application/json

errorstring

Examplejson

{
  "error": "Invalid request body"
}

404Organization not found

application/json

errorstring

Examplejson

{
  "error": "Invalid request body"
}

409Name, version, URL, or content already taken in this organization

application/json

errorstring

Examplejson

{
  "error": "Invalid request body"
}

500Internal server error

application/json

errorstring

Examplejson

{
  "error": "Invalid request body"
}