🚀 Try it for free in Phase Two's Keycloak as a service.

More self-serve. More better.

The Phase Two Admin Portal ties together functionality from the Keycloak Account Console and Phase Two Organizations to allow your customers' users to self-manage as much of their account and organization functionality as is possible.

The Portal is deployed as a Keycloak extension, much like the Account Console, and is available at https://{host}/{relative-path}/realms/{realm}/portal/. Note that we are considering making this a drop-in replacement for the Account Console that can be selected simply in Realm Settings->Themes, but this would make it impossible to use both at the same time.

The easiest way to get started is our Docker image. Documentation and examples for using it are in the phasetwo-containers repo. The most recent version of this extension is included.

docker run --name phasetwo_test --rm -p 8080:8080 \
    -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -e KC_HTTP_RELATIVE_PATH=/auth \
    quay.io/phasetwo/phasetwo-keycloak:$VERSION \
    start-dev --spi-email-template-provider=freemarker-plus-mustache --spi-email-template-freemarker-plus-mustache-enabled=true

Because this extension relies on the APIs provided by the keycloak-orgs extension, it is required to deploy them in the same Keycloak.

Most of the visibilty of functionality in the Portal is controlled by user permissions. However, it is also possible to control visibility through Realm Attributes. These attributes may be set manually, or by using the Phase Two extensions to the Keycloak Admin UI (Styles->Portal tab), which must also be installed in the same Keycloak.

When setting the attributes manually, the values are:

It is also possible to add branding to the portal. It is recommended these, along with logos, are set through the Phase Two extensions to the Keycloak Admin UI, as there are other options there that are reused in Login forms styling, and the UI extensions also ensure that the attributes are set with appropriate values.

The keys specific to the Portal are:

First, setup:

yarn

Then, start a Keycloak, create a public OIDC client with http://localhost:3000 Root URL, and update the public/keycloak.json file with the client config.

Finally, run the development server:

yarn start

Open http://localhost:3000 with your browser to see the result.

mvn clean package

Put the jar in target/admin-portal-{version}.jar in the providers/ directory of your Keycloak distribution.

All documentation, source code and other files in this repository are Copyright 2023 Phase Two, Inc.