keycloak/js/apps/keycloak-server
Michal Vavřík ec1ddc73d4
Added typescript based module for the client admin v2 (#46440)
* Added typescript based module for the client admin v2

Based on the new openapi client admin api this module can be generated
based on the defenition.

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* now uses openapitools to generate and moved it into the existing module for better adoption

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* changed back to use kiota as it offers a nicer fluent api

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* fixed build

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* better api

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* removed base representation filter

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* added flag to explicited enable v2

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* re-run generation

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>

* enable client-admin-api:v2 in PR CI tests

Signed-off-by: Michal Vavřík <michal.vavrik@aol.com>

* fix JS OpenAPI generation on Windows

Signed-off-by: Michal Vavřík <michal.vavrik@aol.com>

* remove unnecessary statement from generate.ts

Signed-off-by: Michal Vavřík <michal.vavrik@aol.com>

* Fix Windows line endings in JS OpenAPI post-processing

Signed-off-by: Michal Vavřík <michal.vavrik@aol.com>

---------

Signed-off-by: Erik Jan de Wit <erikjan.dewit@gmail.com>
Signed-off-by: Michal Vavřík <michal.vavrik@aol.com>
Co-authored-by: Erik Jan de Wit <erikjan.dewit@gmail.com>
2026-02-18 19:34:00 +01:00
..
scripts Added typescript based module for the client admin v2 (#46440) 2026-02-18 19:34:00 +01:00
.gitignore Move all JavaScript projects into single PNPM workspace (#24537) 2024-04-02 16:14:58 +02:00
package.json Bump the npm-dependencies group across 1 directory with 32 updates (#45148) 2026-01-05 15:15:40 +00:00
README.md updated the coding guidelines (#40179) 2025-06-03 12:43:33 +00:00

Keycloak Server

This app allows you to run a local development version of the Keycloak server.

Running the Keycloak server

First, ensure that all dependencies are installed locally using PNPM by running:

pnpm install

After the dependencies are installed we can start the Keycloak server by running the following command:

pnpm start

If you want to run the server against a local development Vite server, you'll have to pass the --admin-dev or --account-dev flag:

pnpm start --admin-dev
pnpm start --account-dev

The above commands will download the Nightly version of the Keycloak server and run it locally on port 8080. If a previously downloaded version was found in the server/ directory then that one will be used instead. If you want to download the latest Nightly version you can remove the server directory before running the command to start the server:

pnpm delete-server

Or if you just want to clear the data so you can start fresh without downloading the server again:

pnpm delete-data

If you want to run with a local Quarkus distribution of Keycloak for development purposes, you can do so by running this command instead:

pnpm start --local

If you want to run Keycloak standalone (without the script) against the Vite development server, you can set the following environment variables to achieve the same result:

KC_ACCOUNT_VITE_URL=http://localhost:5173
KC_ADMIN_VITE_URL=http://localhost:5174
KC_FEATURES=login:v2,account:v3,admin-fine-grained-authz,transient-users,oid4vc-vci

All other arguments will be passed through to the underlying Keycloak server.