@keycloakify/keycloak-account-ui
Version:
<p align="center"> <img src="https://github.com/user-attachments/assets/e31c4910-7205-441c-9a35-e134b806b3a8"> </p> <p align="center"> <i>Repackaged Keycloak Account UI</i> <br> <br> <a href="https://github.com/keycloakify/keycloak-a
37 lines (36 loc) • 1.51 kB
TypeScript
/** The base environment variables that are shared between the Admin and Account Consoles. */
export type BaseEnvironment = {
/**
* The URL to the root of the Keycloak server, including the path if present, this is **NOT** always equivalent to the URL of the Admin Console.
* For example, the Keycloak server could be hosted on `auth.example.com` and Admin Console may be hosted on `admin.example.com/some/path`.
*
* Note that this URL is normalized not to include a trailing slash, so take this into account when constructing URLs.
*
* @see {@link https://www.keycloak.org/server/hostname#_administration_console}
*/
serverBaseUrl: string;
/** The identifier of the realm used to authenticate the user. */
realm: string;
/** The identifier of the client used to authenticate the user. */
clientId: string;
/** The base URL of the resources. */
resourceUrl: string;
/** The source URL for the the logo image. */
logo: string;
/** The URL to be followed when the logo is clicked. */
logoUrl: string;
};
/**
* Extracts the environment variables from the document, these variables are injected by Keycloak as a script tag, the contents of which can be parsed as JSON. For example:
*
*```html
* <script id="environment" type="application/json">
* {
* "realm": "master",
* "clientId": "security-admin-console",
* "etc": "..."
* }
* </script>
* ```
*/
export declare function getInjectedEnvironment<T>(): T;