Documentation
Complete Guide to FreeSCIM Enterprise V3

Everything you need to know to get started with FreeSCIM Enterprise V3, from installation to advanced configuration.

Getting Started
User Guides
Integrations
API Reference
Support

Installation

FreeSCIM Enterprise V3 can be installed on various platforms. Choose the installation method that best fits your environment.

System Requirements

Minimum Requirements
  • CPU: 2 cores
  • RAM: 4GB
  • Storage: 20GB
  • OS: Linux, Windows, macOS
Recommended Requirements
  • CPU: 4+ cores
  • RAM: 8GB+
  • Storage: 100GB+ SSD
  • OS: Ubuntu 20.04+, RHEL 8+

Docker Installation

# Pull the latest image
docker pull freescim/enterprise:v3

# Run the container
docker run -d \
  --name freescim-enterprise \
  -p 8080:8080 \
  -p 8443:8443 \
  -e DATABASE_URL=sqlite:///data/freescim.db \
  -v freescim-data:/data \
  freescim/enterprise:v3

Manual Installation

# Download the installer
wget https://releases.freescim.com/enterprise/v3/freescim-enterprise-v3.tar.gz

# Extract and install
tar -xzf freescim-enterprise-v3.tar.gz
cd freescim-enterprise-v3
./install.sh

# Start the service
systemctl start freescim-enterprise
systemctl enable freescim-enterprise

Quick Start

Get up and running with FreeSCIM Enterprise V3 in minutes with our quick start guide.

1

Access the Web Interface

Open your browser and navigate to https://your-server:8443

2

Complete Initial Setup

Follow the setup wizard to configure your admin account and basic settings.

3

Configure Integrations

Set up your first integration with LDAP, FreeIPA, or Okta.

4

Test User Sync

Verify that users are syncing correctly between your systems.

API Reference

FreeSCIM Enterprise V3 provides a comprehensive REST API for programmatic access to all functionality.

Base URL

https://your-server:8443/api/v1

Authentication

All API requests require authentication using either API keys or OAuth 2.0 tokens.

# Using API Key
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://your-server:8443/api/v1/users

# Using OAuth 2.0
curl -H "Authorization: Bearer YOUR_OAUTH_TOKEN" \
     https://your-server:8443/api/v1/users

Common Endpoints

GET
/users
List all users
POST
/users
Create a new user
GET
/users/{id}
Get user by ID
PUT
/users/{id}
Update user
DELETE
/users/{id}
Delete user

Troubleshooting

Common issues and their solutions to help you resolve problems quickly.

Connection Issues

Problem: Cannot connect to LDAP server

Solution: Check network connectivity, verify credentials, and ensure the LDAP server is accessible.

# Test LDAP connectivity
ldapsearch -H ldap://your-ldap-server:389 -D "cn=admin,dc=example,dc=com" -W

Sync Failures

Problem: User synchronization is failing

Solution: Check the sync logs, verify user permissions, and ensure schema mapping is correct.

Performance Issues

Problem: Slow response times

Solution: Check system resources, optimize database queries, and consider scaling horizontally.