Skip to main content
POST
/
core.v1.PoliciesService
/
CreatePolicy
cURL
curl -X POST "https://api.joinformal.com/core.v1.PoliciesService/CreatePolicy" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "policy": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "code": "<string>",
    "ast": "<string>",
    "notification": "none",
    "owners": [
      {
        "group": {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "dsyncGroupId": "<string>",
          "terminationProtection": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        },
        "user": {
          "id": "<string>",
          "dbUsername": "<string>",
          "type": "machine",
          "terminationProtection": true,
          "expireAt": "2023-11-07T05:31:56Z",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "groupIds": [
            "<string>"
          ],
          "fullName": "<string>",
          "human": {
            "firstName": "<string>",
            "lastName": "<string>",
            "email": "jsmith@example.com"
          },
          "machine": {
            "name": "<string>"
          }
        }
      }
    ],
    "status": "draft",
    "terminationProtection": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "version": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formal.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json

Exactly one of these fields is required: group_name or user_email.

​
name
string
Minimum string length: 1
​
description
string
Minimum string length: 1
​
code
string
Minimum string length: 1
​
notification
enum<string>
Available options:
none,
consumer,
owners,
all
​
status
enum<string>
Available options:
draft,
dry-run,
active
​
terminationProtection
boolean
​
groupName
string

One of the discriminated union fields - use exactly one

​
userEmail
string

One of the discriminated union fields - use exactly one

Response

Success

​
policy
policy · object