Keycloak-User-Purger

Table of Contents

1. About The Project
   • Release Notes
2. Getting Started
   • Prerequisites
   • Installation
3. Security Policy
4. Contributing
5. License
6. Contact

About The Project

This project checks all temporary users in the PORTAL realm and deletes them if the following properties are met:

• No login for more than 48 hours (configurable)
• Attribute 'accountIsTemporary' has the value 'true'

Release Notes

See ReleaseNotes.md for all information regarding the (newest) releases.

Getting Started

Prerequisites

The Project requires Java 21 and Maven 3.8+.

Installation

The Project can be built with the following command:

mvn clean install

The Docker Image associated to the service can be built with the extra profile docker:

mvn clean install -Pdocker

Usage

The application can be executed from a JAR file or a Docker Image:

# As JAR Application
java -jar target/keycloak-user-purger.jar
# As Docker Image
docker run --rm -it -p 8080:8080 keycloak-user-purger:latest

It can also be deployed on Kubernetes by using the Helm Chart defined in the folder deployment/helm/keycloak-user-purger:

helm install keycloak-user-purger ./deployment/helm/keycloak-user-purger

Security Policy

If you want to see the security policy, please check our SECURITY.md.

Contributing

If you want to contribute, please check our CONTRIBUTING.md.

License

EUROPEAN UNION PUBLIC LICENCE v. 1.2

EUPL © the European Union 2007, 2016

Additional Notes and Disclaimer from gematik GmbH

1. Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.
2. Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions::
   1. The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.
   2. The software is provided "as is" without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.
   3. The software is the result of research and development activities, therefore not necessarily quality assured and without the character of a liable product. For this reason, gematik does not provide any support or other user assistance (unless otherwise stated in individual cases and without justification of a legal obligation). Furthermore, there is no claim to further development and adaptation of the results to a more current state of the art.
3. Gematik may remove published results temporarily or permanently from the place of publication at any time without prior notice or justification.
4. Please note: Parts of this code may have been generated using AI-supported technology.’ Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.

See LICENSE.

Contact

E-Mail to DEMIS Entwicklung