Role Management

This endpoint group provides methods for retrieving information about user roles defined within the AppBuilder Framework.

Endpoints

POST /api/rpc (Method: RoleRpc.listRoles)

• Description: Retrieves a list of all available role definitions, including their names and descriptions.

• Request Body:

  {
    "method": "RoleRpc.listRoles",
    "params": {}
  }

• Parameters:

  Name	Type	Required	Description
  params	Object	No	Currently, no parameters are required for this method.

• Response:

  {
    "success": true,
    "data": [
      {
        "name": "public",
        "description": "Default role for unauthenticated users (Framework Default)"
      },
      {
        "name": "user",
        "description": "Default role for authenticated users with standard access (Framework Default)"
      },
      {
        "name": "admin",
        "description": "Default administrator role with full access (Framework Default)"
      }
    ]
  }

  The data field contains an array of role objects, each with a name (string) and description (string). The descriptions are retrieved from the RoleService.

• Example (cURL):

  curl -X POST https://api.example.com/api/rpc \
    -H "Content-Type: application/json" \
    -H "X-API-Key: YOUR_API_KEY" \
    -d '{
      "method": "RoleRpc.listRoles",
      "params": {}
    }'