Modules

Module management operations

Get modules

get

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/module

Retrieve module information

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

moduleIdstringOptional

Filter by module ID

moduleNamestringOptional

Filter by module name

descriptionstringOptional

Filter by description

statusstringOptional

Filter by status

startDatestring · dateOptional

Start date filter

endDatestring · dateOptional

End date filter

pageSizestringOptional

Number of items per page

pageNumberstringOptional

Page number

sortBystringOptional

Sort field

sortOrderstring · enumOptional

Sort order

Possible values:

Responses

200

Modules retrieved successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

get

/rbac/module

HTTPcURLJavaScriptPython

GET /v1/rbac/module HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "pagination": {
    "currentPage": 1,
    "totalPages": 10,
    "totalItems": 100,
    "itemsPerPage": 10,
    "hasNextPage": true,
    "hasPreviousPage": false
  },
  "data": [
    {
      "moduleId": "123e4567-e89b-12d3-a456-426614174000",
      "moduleName": "text",
      "description": "text",
      "status": "active",
      "startDateTime": "2025-12-16T02:50:43.354Z",
      "endDateTime": "2025-12-16T02:50:43.354Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-12-16T02:50:43.354Z",
      "updatedAt": "2025-12-16T02:50:43.354Z"
    }
  ]
}

Create module

post

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/module

Create a new module

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

moduleNamestringRequired

Module name

descriptionstringOptional

Module description

statusstring · enumOptionalDefault: activePossible values:

startDateTimestring · date-timeOptional

endDateTimestring · date-timeOptional

Responses

201

Module created successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

post

/rbac/module

HTTPcURLJavaScriptPython

POST /v1/rbac/module HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "moduleName": "text",
  "description": "text",
  "status": "active",
  "startDateTime": "2025-12-16T02:50:43.354Z",
  "endDateTime": "2025-12-16T02:50:43.354Z"
}

{
  "success": true,
  "message": "Module created successfully",
  "data": {
    "moduleId": "123e4567-e89b-12d3-a456-426614174000",
    "moduleName": "text",
    "description": "text",
    "status": "active",
    "startDateTime": "2025-12-16T02:50:43.354Z",
    "endDateTime": "2025-12-16T02:50:43.354Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-12-16T02:50:43.354Z",
    "updatedAt": "2025-12-16T02:50:43.354Z"
  }
}

Update module

put

https://api.example.com/v1https://staging-api.example.com/v1

/rbac/module/{moduleId}

Update module information

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

moduleIdstring · uuidRequired

Module ID

Body

application/json

moduleNamestringOptional

descriptionstringOptional

statusstring · enumOptionalPossible values:

startDateTimestring · date-timeOptional

endDateTimestring · date-timeOptional

Responses

200

Module updated successfully

application/json

400

Validation error

application/json

500

Internal server error

application/json

put

/rbac/module/{moduleId}

HTTPcURLJavaScriptPython

PUT /v1/rbac/module/{moduleId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144

{
  "moduleName": "text",
  "description": "text",
  "status": "active",
  "startDateTime": "2025-12-16T02:50:43.354Z",
  "endDateTime": "2025-12-16T02:50:43.354Z"
}

{
  "success": true,
  "message": "Module updated successfully",
  "data": {
    "moduleId": "123e4567-e89b-12d3-a456-426614174000",
    "moduleName": "text",
    "description": "text",
    "status": "active",
    "startDateTime": "2025-12-16T02:50:43.354Z",
    "endDateTime": "2025-12-16T02:50:43.354Z",
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-12-16T02:50:43.354Z",
    "updatedAt": "2025-12-16T02:50:43.354Z"
  }
}