Replace role permissions

What this does: Completely replaces the permissions map for a custom role. This is a full replacement - all permissions must be specified in the request.

Important restrictions:

• Base roles cannot have their permissions modified
• Only custom roles can be updated
• All permissions must be provided (this is a complete replacement)

Permission handling:

• Permissions are automatically normalized (removed if false, kept if true)
• Permissions are validated against disallowed permissions for the role type
• Guest roles have restrictions on certain permissions
• Invalid permissions are rejected with error messages

What must be provided:

• permissions: Complete map of all permissions with boolean values
  • true: Permission is allowed
  • false: Permission is disallowed (will be removed from the map)

Permission inheritance:

• If the role has a parent, you can override inherited permissions
• Setting a permission to false explicitly disallows it (even if parent allows it)
• Setting a permission to true explicitly allows it (overrides parent if parent disallows)

Use cases:

• Bulk update all permissions for a role
• Copy permissions from another role by providing its complete permission map
• Reset role permissions to a known state
• Apply permission templates to roles

Note: For updating a single permission, use PATCH /roles//permissions/ instead.

curl -X PUT "https://leadtime.app/api/public/administration/roles/string/permissions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "permissions": {
    "projects.create": true,
    "projects.delete": false,
    "projects.edit": true
  }
}'

const response = await fetch("https://leadtime.app/api/public/administration/roles/string/permissions", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "permissions": {
    "projects.create": true,
    "projects.delete": false,
    "projects.edit": true
  }
})
});

import requests

response = requests.put(
    "https://leadtime.app/api/public/administration/roles/string/permissions",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "permissions": {
    "projects.create": True,
    "projects.delete": False,
    "projects.edit": True
  }
},
)

{
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "description": "Standard employee role",
  "editedAt": "2024-01-01T00:00:00Z",
  "effectivePermissions": {
    "profile.manage": true,
    "tasks.create": true,
    "tasks.delete": false
  },
  "icon": "ri-user-line",
  "id": "workspace-id_employee",
  "name": "Employee",
  "parentId": "workspace-id_admin",
  "permissions": {
    "projects.create": true,
    "projects.delete": false
  },
  "rawPermissions": {
    "tasks.create": true,
    "tasks.delete": false
  },
  "readOnly": false,
  "type": "normal"
}