User Role Management
The user role endpoints allow you to manage role-based access control.
Get User Role
Endpoint
GET /api/user/role
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| userId | string | Unique identifier for the user |
Example Request
GET /api/user/role?userId=user123
Success Response
{
"success": true,
"data": {
"userId": "user123",
"role": "admin",
"permissions": ["read", "write", "delete"]
}
}
Set User Role
Endpoint
POST /api/user/role
Request Body
| Parameter | Type | Description |
|---|---|---|
| userId | string | Unique identifier for the user |
| role | string | Role to assign to the user |
| permissions | array | List of permissions to grant |
Example Request
{
"userId": "user123",
"role": "editor",
"permissions": ["read", "write"]
}
Success Response
{
"success": true,
"data": {
"userId": "user123",
"role": "editor",
"permissions": ["read", "write"]
}
}