v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Permission

Create Permission

Creates a new permission

post/permissions

Headers

tenant-idstring

Request body

resourcestring

The resource name (e.g., 'user', 'roster')

actionstring

The action name (e.g., 'read', 'create')

descriptionstring

A brief description of the permission

Example request

{
  "resource": "user",
  "action": "read",
  "description": "Allows reading user profiles"
}

Response

Permission created successfully

idstring

Permission ID

resourcestring

Resource name

actionstring

Action name

descriptionstring

Permission description

createdAtstring date-time

updatedAtstring date-time

Example response

{
  "id": "perm-123-456-789",
  "resource": "user",
  "action": "read",
  "description": "Allows reading user profiles",
  "createdAt": "2022-03-10T12:15:50-04:00",
  "updatedAt": "2022-03-10T12:15:50-04:00"
}