Skip to main content
POST
/
core.v1.PermissionsService
/
CreatePermission
cURL
curl -X POST "https://api.joinformal.com/core.v1.PermissionsService/CreatePermission" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "permission": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "code": "<string>",
    "status": "draft",
    "terminationProtection": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-KEY
string
header
required

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

Headers

Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
name
string
Minimum string length: 1
description
string
Minimum string length: 1
code
string
Minimum string length: 1
status
enum<string>
Available options:
draft,
dry-run,
active
terminationProtection
boolean

Response

Success

permission
permission · object