added documentation

README.md

@@ -2,11 +2,17 @@
 
 This Repository contains free to use Extensions for the OpenSource Project [Keycloak](https://github.com/keycloak/keycloak)
 
-Contained Extensions:
-
-* Rest-Endpoints
-  * GetUsersByIdResource -> <root_url>/admins/realms/<realm_name>/users-by-id
-    * QueryParams:
-      * briefRepresentation true | false
-      * listWithIds List containing Ids of Users
-    * Returns List of Users
+This repo contains the following extensions:
+
+## Authenticator-Required Action
+
+You can add this Authenticator to your flow, so a User gets the defined Required-Action set on signing in.
+[README.md - Authenticator-Required Action](./authenticator-required-action/README.md)
+
+## Rest-Endpoints
+
+* GetUsersByIdResource -> <root_url>/admins/realms/<realm_name>/users-by-id
+  * QueryParams:
+    * briefRepresentation true | false
+    * listWithIds List containing Ids of Users
+  * Returns List of Users

authenticator-required-action/README.md

@@ -0,0 +1,17 @@
+# Authenticator-Required Action
+
+```mermaid
+flowchart LR
+    CompanyA(RealmCompanyA)-->UsersA
+    CompanyB(RealmCompanyB)-->UsersB
+    UsersA-- Connected via Idp alias: CompanyA ---RealmConciso
+    UsersB-- Connected via Idp alias: CompanyB ---RealmConciso
+```
+
+The First Broker login of Idp CompanyA is configured to set the 'TERMS_AND_CONDITIONS' for all users from CompanyA. Users from CompanyB dont have to accept the terms, so they dont get that action.
+![required-action-flow.png](../docs/pics/required-action-flow.png)
+
+![required-action-authenticator-config.png](../docs/pics/required-action-authenticator-config.png)
+
+To see your availabaddle Required-Actions, go to Realm 'master' -> Provider infor -> Search for 'req' or scroll down until you see 'required-action' in the column for SPI
+![required-action-available-required-actions.png](../docs/pics/required-action-available-required-actions.png)

docker-compose.yaml

@@ -1,5 +1,3 @@
-version: '3'
-
 services:
   keycloak:
     image: quay.io/keycloak/keycloak:23.0.4