> ## Documentation Index > Fetch the complete documentation index at: https://docs.hiperai.com/llms.txt > Use this file to discover all available pages before exploring further. # List Roles > Retrieve all available user roles # List Roles Retrieve all available user roles in the SecureAI system. ## Endpoint ``` GET /roles ``` ## Description This endpoint returns all user roles available in the SecureAI system. It provides detailed information about each role including permissions, descriptions, and metadata. This is useful for understanding the available roles and their capabilities. ## Authentication **Required**: API Key with admin privileges ``` Authorization: Bearer sk-your-api-key-here ``` ## Query Parameters | Parameter | Type | Required | Description | | | ----------- | ------- | -------- | ----------- | -------------------------------------------------- | | `page` | integer | No | 1 | Page number for pagination (default: 1) | | `limit` | integer | No | 20 | Number of roles per page (default: 20) | | `search` | string | No | - | Search term for name, display name, or description | | `isSystem` | string | No | - | Filter by system roles (true/false) | | `sortBy` | string | No | createdAt | Field to sort by (default: "createdAt") | | `sortOrder` | string | No | desc | Sort order (asc/desc, default: "desc") | ## Example Request ```bash theme={null} GET /roles?page=1&limit=10&search=admin ``` ## Success Response **Status Code**: `200 OK` ```json theme={null} { "success": true, "roles": [ { "id": "60a7c8f5e8b4f5001f7a8c26", "name": "custom_role", "displayName": "Custom Role", "description": "Custom role with specific permissions", "isSystem": false, "hasAdminPanelAccess": true, "permissions": [ { "section": "user-management", "level": "admin" }, { "section": "index-management", "level": "reader" } ], "canInteractWithAI": true, "canUseChat": true, "userCount": 5, "createdBy": { "id": "60a7c8f5e8b4f5001f7a8c24", "name": "John Doe", "email": "john@example.com" }, "createdAt": "2024-01-01T00:00:00.000Z", "updatedAt": "2024-01-15T10:30:00.000Z" } ], "pagination": { "page": 1, "limit": 20, "total": 50, "pages": 3 } } ``` ### Response Fields | Field | Type | Description | | ------------------------------- | ------- | ----------------------------------------- | | `success` | boolean | Indicates if the operation was successful | | `roles` | array | Array of role objects | | `roles[].id` | string | Unique role identifier | | `roles[].name` | string | Role name | | `roles[].displayName` | string | Display name for the role | | `roles[].description` | string | Role description | | `roles[].isSystem` | boolean | Whether this is a system role | | `roles[].hasAdminPanelAccess` | boolean | Whether role has admin panel access | | `roles[].permissions` | array | Array of permission objects | | `roles[].permissions[].section` | string | Permission section | | `roles[].permissions[].level` | string | Permission level | | `roles[].canInteractWithAI` | boolean | Whether role can interact with AI | | `roles[].canUseChat` | boolean | Whether role can use chat | | `roles[].userCount` | integer | Number of users with this role | | `roles[].createdBy` | object | User who created the role | | `roles[].createdBy.id` | string | Creator user ID | | `roles[].createdBy.name` | string | Creator name | | `roles[].createdBy.email` | string | Creator email | | `roles[].createdAt` | string | Creation timestamp | | `roles[].updatedAt` | string | Last update timestamp | | `pagination` | object | Pagination information | | `pagination.page` | integer | Current page number | | `pagination.limit` | integer | Items per page | | `pagination.total` | integer | Total number of roles | | `pagination.pages` | integer | Total number of pages | ## Example Usage ### JavaScript ```javascript theme={null} const listRoles = async (params = {}) => { const queryString = new URLSearchParams(params).toString(); const url = `https://{customer.name}.hiperai.ai/api/external/roles${queryString ? `?${queryString}` : ''}`; const response = await fetch(url, { method: 'GET', headers: { 'Authorization': 'Bearer sk-your-api-key-here' } }); return await response.json(); }; // Example usage const result = await listRoles({ page: 1, limit: 10, search: 'admin' }); console.log(result.roles); ``` ### Python ```python theme={null} import requests def list_roles(params=None): url = "https://{customer.name}.hiperai.ai/api/external/roles" headers = { "Authorization": "Bearer sk-your-api-key-here" } response = requests.get(url, headers=headers, params=params) return response.json() # Example usage params = { "page": 1, "limit": 10, "search": "admin" } result = list_roles(params) print(result["roles"]) ``` ### cURL ```bash theme={null} curl -X GET "https://{customer.name}.hiperai.ai/api/external/roles?page=1&limit=10&search=admin" \ -H "Authorization: Bearer sk-your-api-key-here" ``` ## Error Responses ### 401 Unauthorized ```json theme={null} { "success": false, "error": { "code": "UNAUTHORIZED", "message": "Invalid or missing API key" } } ``` ### 403 Forbidden ```json theme={null} { "success": false, "error": { "code": "INSUFFICIENT_PERMISSIONS", "message": "Admin privileges required" } } ``` ### 429 Too Many Requests ```json theme={null} { "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Rate limit exceeded", "retryAfter": 60 } } ``` ## Use Cases * **Role Management**: List all available roles for user assignment * **Permission Review**: Understand what permissions each role has * **Access Control**: Plan user access based on available roles * **User Assignment**: Assign roles to users based on their needs * **Role Analysis**: Analyze role usage and user distribution ## Rate Limits * **Default**: 100 requests per minute * **Daily**: 10,000 requests per day * **Monthly**: 300,000 requests per month ## Notes * This endpoint requires admin privileges * Page-based Pagination: Uses page parameter, not offset * Search: Searches in name, displayName, and description fields * System Roles: Can filter by system vs custom roles * Sorting: Can sort by any field in ascending or descending order * Flat Response: Response is not nested under data object * User Count: Shows how many users have each role * Creator Info: Shows who created each role ## OpenAPI ````yaml GET /roles openapi: 3.0.3 info: title: SecureAI External API description: > SecureAI External API provides AI chat completion and image generation capabilities with knowledge base retrieval, security policies, and comprehensive usage tracking. This API is designed for external developers and integrations using API key authentication. ## Key Features - **RAG (Retrieval-Augmented Generation)**: Automatically search knowledge bases for relevant context - **Multi-Model Support**: OpenAI, Anthropic, Google, Meta, and other AI models - **Model Redundancy & Failover**: Caller-defined failover chains (primary + fallbacks) with per-attempt timeouts - **OpenAI-Compatible Endpoint**: Point any OpenAI SDK at `/api/external/v1` — no code changes - **Image Generation**: Generate and edit images using Google Gemini 2.5 Flash Image - **Speech-to-Speech (S2S)**: Real-time voice conversations using OpenAI Realtime API with WebRTC - **Security Policies**: SMLTP policy enforcement, per-call Prompt Shield, and signed compliance receipts - **Usage Tracking**: Comprehensive usage monitoring, self-service quota, and rate limiting - **Knowledge Base Integration**: Access to personal and shared knowledge bases - **User Management**: Complete user, group, and role management capabilities - **Audit Logging**: Comprehensive activity and security audit logs ## Authentication All endpoints (except health check) require API key authentication using Bearer token: ``` Authorization: Bearer sk-your-api-key-here ``` ## Billing and Usage By default, API requests are billed to the user account that owns the API key. You can specify a different user to bill by including the `user_id` parameter in your request. This allows for: - Multi-tenant applications with per-user billing - Flexible completion limit management - Per-user "Usage by Model" settings ## Rate Limits - Default: 60 requests per minute, 1000 requests per hour - Daily limits: 100 requests (configurable) - Monthly limits: 10,000 requests (configurable) ## Base URL ``` https://secureai.hiperai.ai/api/external ``` version: 1.1.0 contact: name: SecureAI Support email: support@secureai.hiperai.ai license: name: Proprietary url: https://secureai.hiperai.ai/terms servers: - url: https://secureai.hiperai.ai/api/external description: Production server - url: http://localhost:3010/api/external description: Development server security: - ApiKeyAuth: [] tags: - name: System description: System health and status endpoints - name: Discovery description: Endpoints to discover available models, indexes, and policies - name: Chat description: AI chat completion endpoints - name: User Management description: Endpoints for managing user accounts and roles - name: Index Management description: Endpoints for managing knowledge base indexes - name: Group Management description: Endpoints for managing user groups - name: SMLTP Security description: Endpoints for managing SMLTP security policies and audit logs - name: Role Management description: Endpoints for managing user roles - name: Activity Logs description: Endpoints for retrieving activity logs externalDocs: description: SecureAI Documentation url: https://secureai.hiperai.ai/docs paths: /roles: get: tags: - Role Management summary: Get All Roles description: > Retrieve all roles with their permissions. Only accessible by administrators. parameters: - name: page in: query description: Page number for pagination required: false schema: type: integer default: 1 minimum: 1 - name: limit in: query description: Number of roles per page required: false schema: type: integer default: 20 minimum: 1 maximum: 100 - name: search in: query description: Search term for role name, display name, or description required: false schema: type: string - name: isSystem in: query description: Filter by system roles required: false schema: type: string enum: - true - false - name: sortBy in: query description: Field to sort by required: false schema: type: string default: createdAt - name: sortOrder in: query description: Sort order required: false schema: type: string enum: - asc - desc default: desc responses: '200': description: List of roles content: application/json: schema: type: object properties: success: type: boolean example: true roles: type: array items: type: object properties: id: type: string example: 60a7c8f5e8b4f5001f7a8c26 name: type: string example: custom_role displayName: type: string example: Custom Role description: type: string example: Custom role with specific permissions isSystem: type: boolean example: false hasAdminPanelAccess: type: boolean example: true permissions: type: array items: type: object properties: section: type: string example: user-management level: type: string enum: - none - reader - admin example: admin canInteractWithAI: type: boolean example: true canUseChat: type: boolean example: true userCount: type: integer example: 5 createdBy: type: object nullable: true properties: id: type: string example: 60a7c8f5e8b4f5001f7a8c24 name: type: string example: John Doe email: type: string example: john@example.com createdAt: type: string format: date-time example: '2024-01-01T00:00:00.000Z' updatedAt: type: string format: date-time example: '2024-01-15T10:30:00.000Z' pagination: type: object properties: page: type: integer example: 1 limit: type: integer example: 20 total: type: integer example: 50 pages: type: integer example: 3 '401': description: Invalid API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Access denied - admin only content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKeyAuth: [] components: schemas: ErrorResponse: type: object properties: success: type: boolean example: false error: type: string example: Invalid API key message: type: string example: The provided API key is invalid or has been revoked request_id: type: string example: req-abc123 description: Request ID for tracking (if available) securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key authentication using Bearer token format. Example: `Authorization: Bearer sk-your-api-key-here` ````