scim-sim 0.1.0

A SCIM directory simulator and management tool

SCIM Directory Simulator CLI

A command-line tool for simulating and managing a SCIM (System for Cross-domain Identity Management) directory. This tool allows you to create and manage users and groups, simulating a real SCIM-compliant identity provider.

Installation

Requires uv.

uv tool install scim-sim

First-time setup: If scim-sim is not found after installing, run:

uv tool update-shell

Then restart your terminal. This is a one-time step that adds ~/.local/bin to your PATH so all uv-installed tools are available globally.

Alternatively, with pip (uv recommended):

pip install scim-sim

Configuration

Before using the tool, you need to set up your SCIM configuration:

scim-sim setup

This will prompt you for:

• SCIM Base URL - The endpoint of your SCIM service (e.g., https://api.example.com/scim/v2)
• SCIM Auth Token - Your authentication token

Configuration is stored in ~/.scim_config.json. You can view your current configuration with:

scim-sim config

Commands

All commands follow the pattern scim-sim <command> [args]. Run scim-sim --help or scim-sim <command> --help for details.

User Management

# Add a new user (generates random user data)
scim-sim add-user

# Remove a user
scim-sim remove-user <user-id>

Group Management

# Create a new group
scim-sim create-group "Engineering Team"

# Delete a group and permanently delete all its members
scim-sim delete-group <group-id>

# Add user to group
scim-sim add-to-group <user-id> <group-id>

# Remove user from group
scim-sim remove-from-group <user-id> <group-id>

Warning: delete-group permanently deletes all users that belong to the group, not just the group itself.

Directory Visualization

# Show complete directory structure
scim-sim show

This will display a tree view of your directory structure, showing all groups and users.

Example output:

📂 Directory
├── 👥 Groups
│   ├── Engineering Team │ ID: dirgroup_1234567890123456
│   │    ├── 👤 [e-mail] │ ID: diruser_8913202356420102
│   │    └── 👤 [e-mail]        │ ID: diruser_4123456789012345
│   │
│   └── Product Team │ ID: dirgroup_6789012345678901
└── 👤 Ungrouped Users
    └── [e-mail] │ ID: diruser_6789012345678901

Available Commands

• setup - Configure SCIM settings
• config - View current configuration
• add-user - Create a new user
• remove-user - Delete a user
• show - Display directory structure
• create-group - Create a new group
• delete-group - Delete a group and its members
• add-to-group - Add user to group
• remove-from-group - Remove user from group