Skip to content
English
  • There are no suggestions because the search field is empty.

Create policy

POST /api/v1/organizations/{orgId}/policies Select code sample Fetch cURL
const url = 'https://localhost:10001/api/v1/organizations/1/policies';const options = {  method: 'POST',  headers: {Authorization: '
  
   ', 'Content-Type': 'application/json'}, body: '{"controls":[{"citations":[{"title":"example","url":"example"}],"controlCode":"example","createdAt":"example","description":"example","id":1,"policyId":1,"title":"example","updatedAt":"example"}],"createdAt":"example","description":"example","iconUrl":"example","id":1,"name":"example","organizationId":1,"slug":"example","type":"Risk Management","updatedAt":"example","version":"example"}'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}
  
curl --request POST \  --url https://localhost:10001/api/v1/organizations/1/policies \  --header 'Authorization: 
  
   ' \ --header 'Content-Type: application/json' \ --data '{ "controls": [ { "citations": [ { "title": "example", "url": "example" } ], "controlCode": "example", "createdAt": "example", "description": "example", "id": 1, "policyId": 1, "title": "example", "updatedAt": "example" } ], "createdAt": "example", "description": "example", "iconUrl": "example", "id": 1, "name": "example", "organizationId": 1, "slug": "example", "type": "Risk Management", "updatedAt": "example", "version": "example" }'
  

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

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ” orgId required integer

Organization ID

Request Body

Section titled “Request Body ”

Policy object

Media type application/json object controls

Controls within the policy, omitted but populated in list operations

Array object citations Array object title string url string controlCode string createdAt string description string id integer policyId integer title string updatedAt string createdAt string description string iconUrl string id integer name string organizationId integer slug string type

Risk Management, Internal, Regulatory, Custom

stringAllowed values: Risk Management Internal Regulatory Custom updatedAt string version string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created policy

Media type application/json object controls

Controls within the policy, omitted but populated in list operations

Array object citations Array object title string url string controlCode string createdAt string description string id integer policyId integer title string updatedAt string createdAt string description string iconUrl string id integer name string organizationId integer slug string type

Risk Management, Internal, Regulatory, Custom

stringAllowed values: Risk Management Internal Regulatory Custom updatedAt string version string
Example
{  "type": "Risk Management"}

400

Section titled “400 ”

Bad request - Invalid organization ID or request body

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

403

Section titled “403 ”

Forbidden - No organization access or insufficient permissions

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

404

Section titled “404 ”

Organization not found

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}

500

Section titled “500 ”

Internal server error

Media type application/json object key additional properties string
Example generated
{  "additionalProperty": "example"}
Previous
List all policies
Next
Get policy