History

Christophe de Vienne 1945897c85 Fix rest provider example for kc >= 23 Starting with KC23, a @Path is required for an exposed method to work properly Fixes #26088 Signed-off-by: Christophe de Vienne <christophe.devienne@orus.io>		2024-01-10 18:26:53 -03:00
..
src/main	Fix rest provider example for kc >= 23	2024-01-10 18:26:53 -03:00
pom.xml	Use JakartaEE dependencies	2023-04-27 13:36:54 +02:00
README.md	KEYCLOAK-13003 Remove a mention about providers directory	2020-02-17 17:09:27 +01:00

README.md

Example Realm REST Resource provider

You can deploy as a module by running:

$KEYCLOAK_HOME/bin/jboss-cli.sh --command="module add --name=org.keycloak.examples.hello-rest-example --resources=target/hello-rest-example.jar --dependencies=org.keycloak.keycloak-core,org.keycloak.keycloak-server-spi,org.keycloak.keycloak-server-spi-private,javax.ws.rs.api"

Then registering the provider by editing standalone/configuration/standalone.xml and adding the module to the providers element:

<providers>
    ...
    <provider>module:org.keycloak.examples.hello-rest-example</provider>
</providers>

Then start (or restart) the server. Once started open http://localhost:8080/auth/realms/master/hello and you should see the message Hello master. You can also invoke the endpoint for other realms by replacing master with the realm name in the above url.