Ring Platform provides a comprehensive administrative API with 12 secure endpoints for system management, user administration, analytics access, and configuration control. All admin endpoints require ADMIN role and implement enterprise-grade security measures.
🔒 Admin Access Required
All admin endpoints require ADMIN role authentication and are subject to strict rate limiting and audit logging. Unauthorized access attempts are logged and may trigger security alerts.
Role-based Access Control: Multi-level permission system
Audit Logging: All admin actions are logged with timestamps and user context
Rate Limiting: Admin endpoints have stricter rate limits (100 req/hour vs 1000 req/hour for regular users)
IP Whitelisting: Optional IP-based access restrictions
Two-Factor Authentication: Required for sensitive operations
Session Management: Admin sessions have shorter timeouts (1 hour vs 24 hours)
Data Protection
Encryption at Rest: Sensitive admin data encrypted in database
Secure Audit Logs: Admin actions logged to tamper-proof storage
GDPR Compliance: Admin data handling follows strict privacy regulations
Admin API
Ring Platform provides a comprehensive administrative API with 12 secure endpoints for system management, user administration, analytics access, and configuration control. All admin endpoints require ADMIN role and implement enterprise-grade security measures.
🔒 Admin Access Required
All admin endpoints require ADMIN role authentication and are subject to strict rate limiting and audit logging. Unauthorized access attempts are logged and may trigger security alerts.
Role-based Access Control: Multi-level permission system
Audit Logging: All admin actions are logged with timestamps and user context
Rate Limiting: Admin endpoints have stricter rate limits (100 req/hour vs 1000 req/hour for regular users)
IP Whitelisting: Optional IP-based access restrictions
Two-Factor Authentication: Required for sensitive operations
Session Management: Admin sessions have shorter timeouts (1 hour vs 24 hours)
Data Protection
Encryption at Rest: Sensitive admin data encrypted in database
Secure Audit Logs: Admin actions logged to tamper-proof storage
GDPR Compliance: Admin data handling follows strict privacy regulations
Admin API
Ring Platform provides a comprehensive administrative API with 12 secure endpoints for system management, user administration, analytics access, and configuration control. All admin endpoints require ADMIN role and implement enterprise-grade security measures.
🔒 Admin Access Required
All admin endpoints require ADMIN role authentication and are subject to strict rate limiting and audit logging. Unauthorized access attempts are logged and may trigger security alerts.
Role-based Access Control: Multi-level permission system
Audit Logging: All admin actions are logged with timestamps and user context
Rate Limiting: Admin endpoints have stricter rate limits (100 req/hour vs 1000 req/hour for regular users)
IP Whitelisting: Optional IP-based access restrictions
Two-Factor Authentication: Required for sensitive operations
Session Management: Admin sessions have shorter timeouts (1 hour vs 24 hours)
Data Protection
Encryption at Rest: Sensitive admin data encrypted in database
Secure Audit Logs: Admin actions logged to tamper-proof storage
GDPR Compliance: Admin data handling follows strict privacy regulations
Data Retention: Admin logs retained for 7 years for compliance
📋 API Endpoints Reference
GET /api/admin/users
List and search platform users with advanced filtering and pagination.
Parameters
Data Retention: Admin logs retained for 7 years for compliance
📋 API Endpoints Reference
GET /api/admin/users
List and search platform users with advanced filtering and pagination.
Parameters
Data Retention: Admin logs retained for 7 years for compliance
📋 API Endpoints Reference
GET /api/admin/users
List and search platform users with advanced filtering and pagination.
Parameters
Parameter
Type
Required
Description
page
number
No
Page number (default: 1)
limit
number
No
Users per page (default: 50, max: 200)
search
string
No
Search by name, email, or username
role
string
No
Filter by role: VISITOR, MEMBER, CONFIDENTIAL, ADMIN
status
string
No
Filter by status: active, suspended, banned
verified
boolean
No
Filter by email verification status
Parameter
Type
Required
Description
page
number
No
Page number (default: 1)
limit
number
No
Users per page (default: 50, max: 200)
search
string
No
Search by name, email, or username
role
string
No
Filter by role: VISITOR, MEMBER, CONFIDENTIAL, ADMIN
status
string
No
Filter by status: active, suspended, banned
verified
boolean
No
Filter by email verification status
Parameter
Type
Required
Description
page
number
No
Page number (default: 1)
limit
number
No
Users per page (default: 50, max: 200)
search
string
No
Search by name, email, or username
role
string
No
Filter by role: VISITOR, MEMBER, CONFIDENTIAL, ADMIN
status
string
No
Filter by status: active, suspended, banned
verified
boolean
No
Filter by email verification status
Example Request
terminal
bash
Response
json
json
GET /api/admin/users/{id}
Get detailed information about a specific user.
Response
json
json
PUT /api/admin/users/{id}/role
Update a user's role and permissions.
Request Body
json
json
Response
json
json
PUT /api/admin/users/{id}/status
Update a user's account status (suspend, ban, activate).
Request Body
json
json
Response
json
json
DELETE /api/admin/users/{id}
Permanently delete a user account (GDPR compliance).
Parameters
Example Request
terminal
bash
Response
json
json
GET /api/admin/users/{id}
Get detailed information about a specific user.
Response
json
json
PUT /api/admin/users/{id}/role
Update a user's role and permissions.
Request Body
json
json
Response
json
json
PUT /api/admin/users/{id}/status
Update a user's account status (suspend, ban, activate).
Request Body
json
json
Response
json
json
DELETE /api/admin/users/{id}
Permanently delete a user account (GDPR compliance).
Parameters
Example Request
terminal
bash
Response
json
json
GET /api/admin/users/{id}
Get detailed information about a specific user.
Response
json
json
PUT /api/admin/users/{id}/role
Update a user's role and permissions.
Request Body
json
json
Response
json
json
PUT /api/admin/users/{id}/status
Update a user's account status (suspend, ban, activate).
Request Body
json
json
Response
json
json
DELETE /api/admin/users/{id}
Permanently delete a user account (GDPR compliance).
Parameters
Parameter
Type
Required
Description
anonymize
boolean
No
Replace user data with anonymous placeholders (default: true)
deleteContent
boolean
No
Delete all user-generated content (default: false)
reason
string
Yes
Reason for account deletion
Parameter
Type
Required
Description
anonymize
boolean
No
Replace user data with anonymous placeholders (default: true)
deleteContent
boolean
No
Delete all user-generated content (default: false)
reason
string
Yes
Reason for account deletion
Parameter
Type
Required
Description
anonymize
boolean
No
Replace user data with anonymous placeholders (default: true)
deleteContent
boolean
No
Delete all user-generated content (default: false)
reason
string
Yes
Reason for account deletion
Request Body
json
json
Response
json
json
GET /api/admin/analytics
Get comprehensive platform analytics and metrics.
Parameters
Request Body
json
json
Response
json
json
GET /api/admin/analytics
Get comprehensive platform analytics and metrics.
Parameters
Request Body
json
json
Response
json
json
GET /api/admin/analytics
Get comprehensive platform analytics and metrics.
Parameters
Parameter
Type
Required
Description
period
string
No
Time period: hour, day, week, month, year (default: week)
startDate
string
No
ISO date string for custom range
endDate
string
No
ISO date string for custom range
metrics
string[]
No
Specific metrics to include
Parameter
Type
Required
Description
period
string
No
Time period: hour, day, week, month, year (default: week)
startDate
string
No
ISO date string for custom range
endDate
string
No
ISO date string for custom range
metrics
string[]
No
Specific metrics to include
Parameter
Type
Required
Description
period
string
No
Time period: hour, day, week, month, year (default: week)
startDate
string
No
ISO date string for custom range
endDate
string
No
ISO date string for custom range
metrics
string[]
No
Specific metrics to include
Response
json
json
GET /api/admin/analytics/users
Get detailed user analytics.
Parameters
Response
json
json
GET /api/admin/analytics/users
Get detailed user analytics.
Parameters
Response
json
json
GET /api/admin/analytics/users
Get detailed user analytics.
Parameters
Parameter
Type
Required
Description
groupBy
string
No
Group results by: day, week, month, role, status
includeInactive
boolean
No
Include inactive users in results (default: false)
Parameter
Type
Required
Description
groupBy
string
No
Group results by: day, week, month, role, status
includeInactive
boolean
No
Include inactive users in results (default: false)
Parameter
Type
Required
Description
groupBy
string
No
Group results by: day, week, month, role, status
includeInactive
boolean
No
Include inactive users in results (default: false)
GET /api/admin/config
Get current system configuration settings.
Response
json
json
PUT /api/admin/config
Update system configuration settings.
Request Body
json
json
Response
json
json
POST /api/admin/config/rollback
Rollback configuration changes.
Request Body
json
json
GET /api/admin/audit
Get audit logs for admin actions.
Parameters
GET /api/admin/config
Get current system configuration settings.
Response
json
json
PUT /api/admin/config
Update system configuration settings.
Request Body
json
json
Response
json
json
POST /api/admin/config/rollback
Rollback configuration changes.
Request Body
json
json
GET /api/admin/audit
Get audit logs for admin actions.
Parameters
GET /api/admin/config
Get current system configuration settings.
Response
json
json
PUT /api/admin/config
Update system configuration settings.
Request Body
json
json
Response
json
json
POST /api/admin/config/rollback
Rollback configuration changes.
Request Body
json
json
GET /api/admin/audit
Get audit logs for admin actions.
Parameters
Parameter
Type
Required
Description
page
number
No
Page number (default: 1)
limit
number
No
Logs per page (default: 50)
action
string
No
Filter by action type
userId
string
No
Filter by user who performed action
targetUserId
string
No
Filter by user who was affected
startDate
string
No
ISO date - logs after this date
endDate
string
Parameter
Type
Required
Description
page
number
No
Page number (default: 1)
limit
number
No
Logs per page (default: 50)
action
string
No
Filter by action type
userId
string
No
Filter by user who performed action
targetUserId
string
No
Filter by user who was affected
startDate
string
No
ISO date - logs after this date
endDate
string
Parameter
Type
Required
Description
page
number
No
Page number (default: 1)
limit
number
No
Logs per page (default: 50)
action
string
No
Filter by action type
userId
string
No
Filter by user who performed action
targetUserId
string
No
Filter by user who was affected
startDate
string
No
ISO date - logs after this date
endDate
string
Response
json
json
🔧 Implementation Examples
Admin Dashboard Component
Response
json
json
🔧 Implementation Examples
Admin Dashboard Component
Response
json
json
🔧 Implementation Examples
Admin Dashboard Component
import { useState, useEffect } from 'react'import { Card, CardContent, CardHeader, CardTitle } from '@/components/ui/card'interface AdminStats { totalUsers: number activeUsers: number newUsersToday: number totalEntities: number totalOpportunities:
import { useState, useEffect } from 'react'import { Card, CardContent, CardHeader, CardTitle } from '@/components/ui/card'interface AdminStats { totalUsers: number activeUsers: number newUsersToday: number totalEntities: number totalOpportunities:
import { useState, useEffect } from 'react'import { Card, CardContent, CardHeader, CardTitle } from '@/components/ui/card'interface AdminStats { totalUsers: number activeUsers: number newUsersToday: number totalEntities: number totalOpportunities:
User Management Component
User Management Component
User Management Component
import { useState } from 'react'import { Button } from '@/components/ui/button'import { Badge } from '@/components/ui/badge'interface User { id: string name: string email: string role: string status:
import { useState } from 'react'import { Button } from '@/components/ui/button'import { Badge } from '@/components/ui/badge'interface User { id: string name: string email: string role: string status:
import { useState } from 'react'import { Button } from '@/components/ui/button'import { Badge } from '@/components/ui/badge'interface User { id: string name: string email: string role: string status: