Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 1.47 KB

README.md

File metadata and controls

39 lines (23 loc) · 1.47 KB
Raw

Keycloak Execute Actions REST API

This custom Keycloak REST API provides an extra endpoint to generate (and get) an execute-actions link.

It works exactly the same as execute-actions-email from Keycloak source code, but returns the link (instead of an empty response) and avoids sending the email (leaving you the responsibility to send this link to the user).

It adds an endpoint PUT ${serverDomain}/realms/${realm}/execute-actions that expects the following parameters : userId, clientId, redirectUri and actions.

Keycloak Support

Designed for Keycloak >= 21.x.x. May work with other versions, not tested yet.

Deployment

Standalone install

  • Download dist/keycloak-execute-actions-21.x.x.jar from this repository
  • Add it to $KEYCLOAK_HOME/standalone/deployments/

Docker install

If you are using the official Docker image, here is a Dockerfile that automate the installation procedure described above:

FROM quay.io/keycloak/keycloak:21.0.0

COPY keycloak-execute-actions-21.x.x.jar /opt/keycloak/providers/keycloak-execute-actions.jar

Development

Build library

    $ ./gradlew build

Credits

This repository is hugely inspired by Keycloak Configuration Token REST API. Thanks to its owner for creating and sharing a codebase with a Keycloak provider that provides a new endpoint and works well with Keycloak 21.x.x !