Managing Authentik users via YAML files
Project description
Authentik User Manager
Manage Authentik users and group memberships via YAML configuration files.
Features
- Synchronize users and group memberships with Authentik instance
- Configure users and their group memberships via YAML files
- Create individual invitation links for new users
- Email notification system for user invitations
Installation
Install and run via pipx (Recommended)
pipx makes installing and running Python programs easier and avoids conflicts with other packages. Install it with:
pip3 install pipx
The following one-liner both installs and runs this program from PyPI:
pipx run authentik-user-manager
If you want to use authentik-user-manager without prepending it with pipx run every time, install it globally:
pipx install authentik-user-manager
To upgrade authentik-user-manager to the newest available version:
pipx upgrade authentik-user-manager
Other installation methods
You may also use pip directly:
pip install authentik-user-manager
CLI Usage
authentik-user-manager provides a command-line interface for synchronizing users and their group memberships with an Authentik instance.
Command Structure
auth-user-mgr <command> [options]
Main Commands
sync
Synchronize users with the Authentik instance:
auth-user-mgr sync -c <config_file> -u <users_file_or_directory>
For detailed help on any command with additional flags such as --dry and --no-email:
auth-user-mgr --help
auth-user-mgr sync --help
Configuration
The application's configuration and the list of managed users are stored in YAML files. You can find sample configuration files in the config/ directory.
Note: There are two ways how to store your users inventory:
- In a single file, as shown in
config/users.sample.yaml - In multiple files in one directory, as shown in
config/users.sample/
API permissions
Especially for automated syncs, it is recommended to set up a system user in Authentik and create an API token for them. The following permissions are required:
- User: Can view User
- Group: Can view Group
- Group: Add user to group
- Group: Remove user from group
- Group: Can add Group
- Flow: Can view Flow
- Invitation: Can view Invitation
- Invitation: Can add Invitation
- Invitation: Can delete Invitation
Development and Contribution
We welcome contributions to improve this library. Please read CONTRIBUTING.md for all information.
License
The content of this repository is licensed under the Apache 2.0 license.
There may be components under different, but compatible licenses or from different copyright holders. The project is REUSE compliant which makes these portions transparent. You will find all used licenses in the LICENSES directory.
The project has been started by the OpenRail Association. You are welcome to contribute!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file authentik_user_manager-1.1.0.tar.gz.
File metadata
- Download URL: authentik_user_manager-1.1.0.tar.gz
- Upload date:
- Size: 14.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f48ed4a86aeb87349f0db6da9ce7dcedd70c8da25ba8fef87126d31fddaa2703
|
|
| MD5 |
06ebaddcedaa7d3fa4e382d498a76251
|
|
| BLAKE2b-256 |
eb139c5d32dc0dcf0a87951dbd87a844746da5dd1bdb4f3d0cba57a0752715e0
|
File details
Details for the file authentik_user_manager-1.1.0-py3-none-any.whl.
File metadata
- Download URL: authentik_user_manager-1.1.0-py3-none-any.whl
- Upload date:
- Size: 18.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e5ba0bc202be0a7cefc28419811d5796c92aa57012d8acb4d9336d84f0fd423
|
|
| MD5 |
4fe5e2ea325c23f3ca645b04d976461b
|
|
| BLAKE2b-256 |
2df57f816833ae4852c6e254af7ee6a14d3b73d4b681612986db220d9ea5d614
|
