POST Roles (store)

Developing

POST

/api/roles

Create a new role from a predefined template (full_access, limited_access, or consultant_access). Optionally override template permissions with a specific permission ID array. Role name must be unique within the organization.

Permission: view roles (route middleware) + Policy create

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-dev.commandroom.ai/api/api/roles' \
--header 'Authorization: Bearer {{token}}' \
--header 'X-Tenant-UUID: ' \
--header 'Content-Type: application/json' \
--data '{
  "name": "Sample Name",
  "description": "Sample description text.",
  "template": "full_access",
  "permissions": [
    1
  ],
  "is_default": true
}'

Response Example

201 - OK

{
  "message": "Success.",
  "data": {
    "id": 1,
    "name": "Sample Name",
    "description": "Sample description text.",
    "guard_name": "Sample Guard Name",
    "is_default": true,
    "organization_id": 1,
    "permissions": [
      {
        "id": 1,
        "name": "Sample Name"
      }
    ],
    "users": [
      {
        "id": 1,
        "name": "Sample Name",
        "email": "user@example.com"
      }
    ],
    "created_at": "2026-01-15T10:30:00.000000Z",
    "updated_at": "2026-01-15T10:30:00.000000Z"
  }
}

Modified at 2026-07-02 04:47:16

GET Roles (index)

GET Permissions (permissions)