Frontegg MCP Server

🚀 Frontegg Management Interface Tool Documentation

This documentation provides a comprehensive guide to installing, configuring, and using the Frontegg Management Interface Tool, along with API documentation and solutions to common issues.

🚀 Quick Start

Get up and running with the Frontegg Management Interface Tool in no time.

📦 Installation

1. Clone the Repository

Clone the Frontegg Management Interface Tool repository using the following commands in your terminal:

git clone https://github.com/your-organization/frontegg-management-interface.git
cd frontegg-management-interface

2. Install Dependencies

Install the project's required dependencies using npm:

npm install

3. Start the Development Server

After the installation is complete, start the development server:

npm run dev

By default, the application will run at http://localhost:8080.

📚 Documentation

Configuration Guide

1. Environment Variable Configuration

Create a .env file in the project's root directory and add the following content:

NEXT_PUBLIC_API_BASE_URL=http://localhost:3000

If your API server runs on a different port or domain, modify the URL accordingly.

API Documentation

Application Management

Get Users of a Specific Application

curl --header "Authorization: Bearer YOUR_API_TOKEN" http://localhost:8080/api/users/application/YOUR_APPLICATION_ID

Assign a User to an Application

curl --header "Authorization: Bearer YOUR_API_TOKEN" \
--data '{"userId":"USER_ID","applicationId":"APPLICATION_ID"}' \
-X POST http://localhost:8080/api/users/assign

Frequently Asked Questions

1. How to Solve the Problem of Unable to Connect to the API?

Check the following points:

• Ensure that the API server is running.
• Confirm that the API base URL in the .env file is correct.
• Make sure that the network is not blocked by a firewall or proxy.

2. How to Handle a 401 Unauthorized Error?

Ensure that the API token you are using is correctly set in the request header:

curl --header "Authorization: Bearer YOUR_API_TOKEN" http://localhost:8080/api/users

Advanced Configuration

1. Configure Multi-Environment Support

Add variables for different environments in the .env file, for example:

NEXT_PUBLIC_API_BASE_URL=development=http://localhost:3000
NEXT_PUBLIC_API_BASE_URL=staging=https://api.staging.example.com

Then use process.env.NODE_ENV in your code to switch between different environment configurations.

2. Enable Gzip Compression

Add the following content to next.config.js to enable gzip compression:

module.exports = {
  compress: true,
}

Best Practices

1. Security Recommendations

• Do not expose the API token directly in the front-end code.
• Use environment variables to manage sensitive information.
• Regularly review and update the API documentation.

2. Performance Optimization

• Use a caching mechanism to reduce the frequency of calls to downstream services.
• Combine multiple API requests to reduce network latency.

Development Guide

1. Contribute Code

Fork the repository on GitHub, submit your changes, and create a pull request.

2. Use Testing Tools

Run the following command to start testing:

npm test

3. Debugging Tips

Use console.log to output debugging information, or use Chrome's developer tools for debugging.

That's the complete installation and configuration guide for the Frontegg Management Interface Tool. We hope it helps!