1
1
Fork
You've already forked admin-api
0
Management REST API for grommunio
  • Python 99.4%
  • CMake 0.4%
  • Shell 0.2%
Find a file
2026年01月07日 03:07:11 +00:00
api Fix schema version detection and evaluation 2025年12月17日 16:38:18 +01:00
cli Fix for Custom Mapping in orgs, fix CLI 2026年01月07日 03:07:11 +00:00
conf.d Fix typos 2023年02月11日 13:28:10 +01:00
data Change mconf file group ownership to gromoxcf 2024年03月12日 18:48:39 +01:00
doc Update g-admin ldap docs with new switches 2026年01月01日 16:01:56 +13:00
endpoints Fix display of aliased services 2025年10月23日 15:00:23 +02:00
orm Fix for Custom Mapping in orgs, fix CLI 2026年01月07日 03:07:11 +00:00
res Bump openapi spec version 2025年10月23日 15:00:27 +02:00
services Centralize LDAP connection setup 2025年12月17日 16:24:57 +01:00
tools Fix schema version detection and evaluation 2025年12月17日 16:38:18 +01:00
.gitignore Switch to proper build system 2021年09月30日 17:30:19 +02:00
CMakeLists.txt grommunio-admin-api 1.17 2025年02月17日 14:36:40 +01:00
config.yaml Implement service infrastructure 2021年09月30日 17:29:52 +02:00
LICENSE.txt Switch to SPDX compliant tags 2020年12月07日 14:12:58 +01:00
main.py Use main python interpreter 2025年09月05日 12:39:07 +02:00
Pipfile Pipfile: add crypt-r dependency 2025年10月23日 14:53:17 +02:00
README.md readme: remove excessive use of bold typeface 2022年12月18日 12:54:54 +01:00

grommunio Admin API

project license latest version code size

grommunio Admin API is the central API component of grommunio managing appliance(s), domain(s), users(s) and more. grommunio API orchestrates any components and architectures required to operate and manage the entire grommunio stack.

Overview

About grommunio Admin API

  • OpenAPI 3.0 based REST API and interactive CLI
  • Web-based access via grommunio Admin Web
  • Management of grommunio components
  • User, group and mailing list management
  • User synchronization with LDAP-capable backends
  • Account-retrieval via fetchmail
  • Public Folder management
  • Role management with System, Organization and Domain roles
  • Tenant management with organizations and domains
  • Configuration through grommunio-dbconf
  • Realtime connection status incl. mobile devices
  • Log Viewer
  • Mail transport queue and Task queue
  • Distributable, compatible with load balancers such as haproxy, apisix, KEMP and others
  • Secure, with extended security checks and CSRF tokens

Getting Started

Prerequisites

  • uwsgi application server with uwsgi-python3 plugin
  • MySQL or MariaDB database server as central storage (as used and set up by gromox)
  • python3-pyexmdb for gromox store management (provided by libexmdbpp)
  • Recommended: a web server with a working TLS configuration (e.g. nginx)

Installation

Usage

or

Support

For direct contact to the maintainers (for example to supply information about a security-related responsible disclosure), you can contact grommunio directly at dev@grommunio.com

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Security

grommunio Admin API follows good practices of security. grommunio constantly monitors security related issues. grommunio Admin API is provided "as is" without any warranty. For professional support options through subscriptions, head over to grommunio.

For more information and to report security issues, please refer to our security documentation.

Coding style

This repository follows coding style loosely based on PEP8 standard (exception: maximum line width of 127).

License

This project is licensed under the GNU Affero General Public License v3.

See LICENSE for more information.