Skip to main content

GET /api/modules

Retrieves a list of all modules in the authorization service.

Authentication

Requires authentication with valid JWT token.

Response

Returns an array of module objects.
id
UUID
Unique identifier for the module
name
string
Module name
path
string
Module path
icon
string
Module icon identifier
status
string
Module status (e.g., ACTIVE, INACTIVE)

Status Codes

  • 200 OK - List returned successfully

Example Request

curl -X GET https://api.example.com/api/modules \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Example Response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "User Management",
    "path": "/users",
    "icon": "users-icon",
    "status": "ACTIVE"
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "name": "Role Management",
    "path": "/roles",
    "icon": "roles-icon",
    "status": "ACTIVE"
  },
  {
    "id": "770e8400-e29b-41d4-a716-446655440002",
    "name": "Permission Management",
    "path": "/permissions",
    "icon": "permissions-icon",
    "status": "INACTIVE"
  }
]

Build docs developers (and LLMs) love