Create a permission set

POST

/api/v2/permission-sets/

Create a new permission set for the authenticated user's organization.

Request Body:
Name, optional description, default flag, and a permissions object defining
scoped access levels. If any of edit/delete/publish is broader than view,
view is automatically escalated to match (to all if the broader scopes mix
team and project, since neither implies the other).

Request Headers:

X-Organization-Id (int, optional): Override the org scoping these permission sets.
Requires manage (admin) access to the specified organization.

Returns:

The newly created permission set under data.permission_set.

X-Authorization-Consistency-Token (string): Authorization consistency token returned after a write operation. Pass this in subsequent read requests to ensure read-after-write consistency.

Current Version:

2.0.0

Request

Header Params

Body Params

application/json

Required

Examples

Responses

🟢201

application/json

Permission set created successfully

Bodyapplication/json

🟠400

🟠403

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/permission-sets/' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Agent Editors",
    "description": "Can view all agents and edit team agents",
    "is_default": false,
    "permissions": {
        "agents": {
            "view": "all",
            "edit": "team",
            "delete": null,
            "publish": null,
            "create": false
        }
    }
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "permission_set": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "organization_id": 0,
            "name": "string",
            "description": "string",
            "is_default": true,
            "is_system": true,
            "is_deleted": true,
            "permissions": {
                "property1": "string",
                "property2": "string"
            }
        }
    }
}

List org permission sets

Retrieve a permission set