eCR Viewer
    Preparing search index...

    Interface Authentication

    interface Authentication {
        AUTH_CLIENT_ID?: string;
        AUTH_CLIENT_SECRET?: string;
        AUTH_ISSUER?: string;
        AUTH_PROVIDER?: "keycloak" | "ad";
        NBS_API_PUB_KEY?: string;
        NBS_PUB_KEY?: string;
        NEXTAUTH_SECRET?: string;
    }

    Hierarchy (View Summary)

    Index

    Authentication - Integrated

    These variables are used to configure authentication for the eCR Viewer. All values are required when running a INTEGRATED or DUAL configuration.

    NBS_API_PUB_KEY? NBS_PUB_KEY?

    Authentication - Non-Integrated

    These variables are used to configure authentication for the eCR Library & Viewer. All values are required when running a NON_INTEGRATED or DUAL configuration.

    AUTH_CLIENT_ID? AUTH_CLIENT_SECRET? AUTH_ISSUER? AUTH_PROVIDER? NEXTAUTH_SECRET?

    Authentication - Integrated

    NBS_API_PUB_KEY?: string

    Public key for NBS authentication for API Routes. \n This public key should correspond to a private key that you generate and use to create tokens when using the private api routes. To generate these keys, you can use PuttyGen for Windows or ssh-keygen for MacOS/Linux

    NBS_PUB_KEY?: string

    Public key for NBS authentication for viewer. \n This public key should correspond to a private key that you generate and store within the NBS Configuration table. To generate these keys, you can use PuttyGen for Windows or ssh-keygen for MacOS/Linux

    Authentication - Non-Integrated

    AUTH_CLIENT_ID?: string

    The application/client id used to identify the client.

    AUTH_CLIENT_SECRET?: string

    The client secret that comes from the authentication provider.

    AUTH_ISSUER?: string

    Additional information used during authentication process. For Azure AD, this will be the 'Tenant Id'. For Keycloak, this will be the url issuer including the realm.

    Keycloak
    https://my-keycloak-domain.com/realms/My_Realm

    Azure
    4a62fd3e-be14-443f-b51d-a9facca4a0eb
    AUTH_PROVIDER?: "keycloak" | "ad"

    The authentication provider used for logging in. Supported values are keycloak for Keycloak or ad for Azure AD/Entra.

    NEXTAUTH_SECRET?: string

    A random key used for NextAuth.js sessions. This value can be generated by running openssl rand -base64 32.

    Settings

    Member Visibility

    On This Page

    Authentication - Integrated
    Authentication - Non-Integrated