Role Management

GET /users/roles

Get roles with permissions

Retrieve a list of all roles along with their associated permissions

Status Codes:

• 200 OK – List of roles with permissions

• 500 Internal Server Error – Internal server error

POST /users/roles

Create role

Create a new role with permissions

Request JSON Object:

• created_at (string)

• default (boolean)

• description (string)

• id (integer)

• name (string) – (required)

• permissions[].created_at (string)

• permissions[].id (integer)

• permissions[].name (string)

• role (string) – (required)

• updated_at (string)

Status Codes:

• 200 OK – Role created successfully

• 400 Bad Request – Invalid request payload or role already exists

• 500 Internal Server Error – Internal server error

Response JSON Object:

• created_at (string)

• default (boolean)

• description (string)

• id (integer)

• name (string) – (required)

• permissions[].created_at (string)

• permissions[].id (integer)

• permissions[].name (string)

• role (string) – (required)

• updated_at (string)

DELETE /users/roles/{id}

Delete role

Delete a role (cannot delete default roles or assigned roles)

Parameters:

• id (string) – Role ID

Status Codes:

• 200 OK – Role deleted successfully

• 400 Bad Request – Cannot delete default or assigned role

• 404 Not Found – Role not found

• 500 Internal Server Error – Internal server error

PUT /users/roles/{id}

Update role

Update role details and permissions (cannot update default roles)

Parameters:

• id (string) – Role ID

Request JSON Object:

• created_at (string)

• default (boolean)

• description (string)

• id (integer)

• name (string) – (required)

• permissions[].created_at (string)

• permissions[].id (integer)

• permissions[].name (string)

• role (string) – (required)

• updated_at (string)

Status Codes:

• 200 OK – Role updated successfully

• 400 Bad Request – Cannot update default role or invalid request

• 404 Not Found – Role not found

• 500 Internal Server Error – Internal server error