This document provides a comprehensive reference for all SCIM Server endpoints, URLs, and API usage. The server includes both SCIM 2.0 endpoints for identity provider integration and Frontend API endpoints for web-based management.
http://localhost:7001
All API endpoints require API key authentication using Bearer token format:
- Default API Key:
api-key-12345(for normal operations) - Test API Key:
test-api-key-12345(for testing operations)
Authorization: Bearer api-key-12345
For production use, configure Caddy to automatically inject the API key:
localhost:7001 {
env SCIM_API_KEY
reverse_proxy localhost:7001 {
header_up Authorization "Bearer {env.SCIM_API_KEY}"
}
}Then set the environment variable:
export SCIM_API_KEY="api-key-12345"The Frontend API provides web UI endpoints for reading server state and exporting server data. These endpoints are separate from the core SCIM functionality and are designed to support a web-based management interface.
http://localhost:7001/api/
GET /api/list-servers
Returns a summary of all available SCIM servers with their statistics.
{
"servers": [
{
"server_id": "test-hr-server",
"stats": {
"users": 3,
"groups": 2,
"entitlements": 3,
"user_group_relationships": 5,
"user_entitlement_relationships": 6
},
"config": {
"server_id": "test-hr-server",
"name": "SCIM Server test-hr-server",
"description": "Dynamic SCIM server with ID test-hr-server",
"app_profile": "hr",
"enabled_resource_types": ["User", "Group", "Entitlement"]
},
"app_profile": "hr",
"last_updated": "2025-07-28T23:15:16.197154Z"
}
],
"total": 45,
"generated_at": "2025-07-28T23:15:16.197173Z"
}curl -H "Authorization: Bearer api-key-12345" \
http://localhost:7001/api/list-serversGET /api/export-server/{server_id}
Exports complete server data including all users, groups, entitlements, and relationships.
server_id(string): The UUID of the server to export
include_relationships(boolean, default:true): Whether to include user-group and user-entitlement relationships
{
"server_id": "test-hr-server",
"summary": {
"server_id": "test-hr-server",
"stats": {
"users": 3,
"groups": 2,
"entitlements": 3,
"user_group_relationships": 5,
"user_entitlement_relationships": 6
},
"config": { /* server configuration */ },
"app_profile": "hr",
"last_updated": "2025-07-28T23:15:16.197154Z"
},
"users": [
{
"id": 1,
"scim_id": "user-123",
"user_name": "john.doe",
"display_name": "John Doe",
"email": "john.doe@example.com",
"active": true,
"server_id": "test-hr-server",
"entitlements": [
{
"id": 1,
"scim_id": "entitlement-123",
"display_name": "Office 365 License",
"type": "application_access"
}
],
"groups": [
{
"id": 1,
"scim_id": "group-123",
"display_name": "Engineering Team",
"description": "Engineering department"
}
]
}
],
"groups": [
{
"id": 1,
"scim_id": "group-123",
"display_name": "Engineering Team",
"description": "Engineering department",
"server_id": "test-hr-server",
"members": [
{
"user_id": 1,
"user_name": "john.doe",
"display_name": "John Doe"
}
]
}
],
"entitlements": [
{
"id": 1,
"scim_id": "entitlement-123",
"display_name": "Office 365 License",
"type": "application_access",
"description": "Microsoft Office 365 license type",
"server_id": "test-hr-server",
"assigned_users": [
{
"user_id": 1,
"user_name": "john.doe",
"display_name": "John Doe"
}
]
}
],
"metadata": {
"exported_at": "2025-07-28T23:15:16.197173Z",
"include_relationships": true,
"users_count": 3,
"groups_count": 2,
"entitlements_count": 3
}
}# Export with relationships
curl -H "Authorization: Bearer api-key-12345" \
"http://localhost:7001/api/export-server/test-hr-server?include_relationships=true"
# Export without relationships
curl -H "Authorization: Bearer api-key-12345" \
"http://localhost:7001/api/export-server/test-hr-server?include_relationships=false"GET /api/server-stats/{server_id}
Returns detailed statistics for a specific server.
server_id(string): The UUID of the server to get stats for
{
"server_id": "test-hr-server",
"stats": {
"users": 3,
"groups": 2,
"entitlements": 3,
"user_group_relationships": 5,
"user_entitlement_relationships": 6
},
"config": {
"server_id": "test-hr-server",
"name": "SCIM Server test-hr-server",
"description": "Dynamic SCIM server with ID test-hr-server",
"app_profile": "hr",
"enabled_resource_types": ["User", "Group", "Entitlement"]
},
"app_profile": "hr",
"generated_at": "2025-07-28T23:15:16.197154Z"
}curl -H "Authorization: Bearer api-key-12345" \
http://localhost:7001/api/server-stats/test-hr-serverThe SCIM API implements RFC 7644 compliant endpoints for identity provider integration.
/scim-identifier/{server_id}/scim/v2
- Test HR Server:
http://localhost:7001/scim-identifier/test-hr-server/scim/v2/ - Test IT Server:
http://localhost:7001/scim-identifier/test-it-server/scim/v2/
- URL:
/Users - Methods: GET, POST, PUT, PATCH, DELETE
- Description: User management operations
- URL:
/Groups - Methods: GET, POST, PUT, PATCH, DELETE
- Description: Group management operations
- URL:
/Entitlements - Methods: GET, POST, PUT, PATCH, DELETE
- Description: Entitlement management operations
- URL:
/ResourceTypes - Methods: GET
- Description: Schema discovery for available resource types
- URL:
/Schemas - Methods: GET
- Description: Schema discovery for all available schemas
http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Users
http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Groups
http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Entitlements
http://localhost:7001/scim-identifier/test-hr-server/scim/v2/ResourceTypes
http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Schemas
curl -H "Authorization: Bearer api-key-12345" \
"http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Users"curl -H "Authorization: Bearer api-key-12345" \
"http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Users/user-123"curl -X POST \
-H "Authorization: Bearer api-key-12345" \
-H "Content-Type: application/scim+json" \
-d '{
"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
"userName": "john.doe",
"displayName": "John Doe",
"emails": [{"value": "john.doe@example.com", "primary": true}],
"active": true
}' \
"http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Users"curl -H "Authorization: Bearer api-key-12345" \
"http://localhost:7001/scim-identifier/test-hr-server/scim/v2/Groups"curl -H "Authorization: Bearer api-key-12345" \
"http://localhost:7001/scim-identifier/test-hr-server/scim/v2/ResourceTypes"- URL:
http://localhost:7001/ - Description: Modern web interface for managing SCIM servers
- Features: Server listing, data export, statistics visualization
- URL:
http://localhost:7001/static/ - Description: Static assets for the web interface
- URL:
http://localhost:7001/healthz - Description: Basic health check endpoint for readiness/liveness probes
- Authentication: Not required
- Access: Public - accessible from any network
- URL:
http://localhost:7001/health - Description: Detailed health check endpoint with database status and comprehensive information
- Authentication: Not required
- Access: Internal networks only (localhost, private networks, Docker networks)
- URL:
http://localhost:7001/api - Description: API information and endpoint documentation
- Authentication: Not required
- URL:
http://localhost:7001/routing - Description: Routing configuration and SCIM client compatibility info
- Authentication: Not required
{
"detail": "Authorization header required"
}{
"detail": "Authorization header must start with 'Bearer '"
}{
"detail": "Invalid or inactive API key"
}{
"detail": "Server ID is required"
}{
"detail": "Server ID must contain only alphanumeric characters, hyphens, and underscores"
}{
"detail": "Server 'invalid-server-id' not found or has no data"
}{
"detail": "Error listing servers: Database connection failed"
}All API endpoints are subject to rate limiting:
- Read operations: 500 requests per 30 minutes
- Write operations: 500 requests per 30 minutes
Both Frontend API and SCIM API endpoints support CORS for cross-origin requests from web applications.
- All endpoints return JSON responses
- Timestamps are in ISO 8601 format with UTC timezone
- Server IDs must be alphanumeric with hyphens and underscores only
- Relationships are included by default but can be disabled for performance
- The web interface automatically hides API key input when using Caddy proxy setup
- SCIM endpoints follow RFC 7644 specification exactly
- Frontend API endpoints are designed for web UI consumption
GET /api/list-servers- List all serversGET /api/export-server/{server_id}- Export server dataGET /api/server-stats/{server_id}- Get server statistics
GET /scim-identifier/{server_id}/scim/v2/Users- List usersGET /scim-identifier/{server_id}/scim/v2/Groups- List groupsGET /scim-identifier/{server_id}/scim/v2/Entitlements- List entitlementsGET /scim-identifier/{server_id}/scim/v2/ResourceTypes- Get resource typesGET /scim-identifier/{server_id}/scim/v2/Schemas- Get schemas
GET /healthz- Health checkGET /api/info- API informationGET /api/protected- Authentication test endpointGET /api/routing- Routing informationGET /frontend/index.html- Web interfaceGET /- 404 Not Found (no root endpoint)
GET /frontend/index.html- Web UI for managing SCIM serversGET /frontend/static/*- Static assets for the web interface