DocumentationAPI ReferenceRelease Notes
Log In
Documentation

How is this integration useful?

BeyondTrust Endpoint Privilege Management allows privilege escalation on Windows desktops. For example, if a policy is configured to require escalation to run Windows cmd.exe, then the BeyondTrust client prompts for multi-factor authentication. Authentication with (for example) HYPR is initiated by the end user when they click a link that reads Authenticate with Your Identity Provider.

⚠️

Important

Third-party documentation is subject to change. Updates might not be reflected in BeyondTrust documentation. For the most up-to-date information, visit https://www.hypr.com/support or https://www.keycloak.org.

Workflow user example of authenticating with HYPR

  1. User attempts to run cmd.exe as an administrator.
  2. BeyondTrust makes a request to confirm elevation.
  3. The user is authenticated via HYPR.
  4. HYPR prompts the user to continue on the HYPR Mobile App.

Install the EPM for Windows client on Windows Desktop

  1. In EPM for Windows and Mac, from the left menu, click Configuration > Privilege Management Installation.
  2. Download the installers.

Configure your OIDC in EPM for Windows and Mac

For instructions, see Configure multi-factor authentication.

Configure your HYPR/Keycloak identity provider

  1. Login to the Keycloak admin page and select the BeyondTrust realm in the drop-down.

  2. Click Clients in the left navigation menu. The main pane defaults to the Clients list tab.

  3. Click Create client. The Create client dialog opens.

  4. Client creation progress is outlined on the left of the client properties. Fill in the fields as described in the following tables:

    • General settings fields
      FieldValue
      Client typeOpenID Connect
      Client IDBeyondTrustPMC
      NameBeyondTrust Privilege Management
      DescriptionAn optional field for descriptive text.
      Always display in UIOff
    • Capability config settings
      FieldValue
      Client authenticationOff
      AuthorizationOff
      Authentication flow: Standard flowOn
      Authentication flow: Direct access grantsOn
      Always display in UIOff
      Authentication flow: Implicit flowOn
      Authentication flow: Service accounts rolesOff
      Authentication flow: OAuth 2.0 Device Authorization GrantOn
      Authentication flow: OIDC CIBA GrantOff
    • Login settings
      Login SettingsValue
      Root URLhttps://bt-int.gethypr.com
      Home URL(Leave blank.)
      Valid redirect URIs(Leave blank.)
      Valid post logout redirect URIs(Leave blank.)
      Web origins(Leave blank.)

Configure client settings

  1. Login to the Keycloak admin page and select the BeyondTrust realm in the drop-down.
  2. Click Clients in the left navigation menu.
    A list of clients populates the main pane.
  3. Select the client you just created.
    This example uses https://bt-int.gethypr.com.
  4. A set of tabs displays for the client properties:
  • Settings

    General

    FieldValue
    Client IDBeyondTrustPMC
    NameThe name defined at creation. (BeyondTrustPMC]
    DescriptionAn optional field for additional information.
    Always display in UIOn

    Access Settings

    FieldValue
    Root URLhttps://bt-int.gethypr.com
    Home URL(Leave blank.)
    Valid redirect URIs-
    Valid post logout redirect URIs-
    Web origins-
    Admin URLhttps://bt-int.gethypr.com

    Capabilities Config

    FieldValue
    Client authenticationOff
    AuthorizationOff
    Authentication flow: Standard flowOn
    Authentication flow: Direct access grantsOn
    Authentication flow: Implicit flowOn
    Authentication flow: Service accounts rolesOff
    Authentication flow: OAuth 2.0 Device Authorization GrantOn
    Authentication flow: OIDC CIBA GrantOff

    Login Settings

    FieldValue
    Login themeChoose… (Leave unchosen.)
    Consent requiredOff
    Display client on screenOff
    Client consent screen text(Leave blank.)

    Logout Settings

    FieldValue
    Front channel logoutOn
    Front-channel logout URL(Leave blank.)
    Backchannel logout URL(Leave blank.)
    Backchannel logout session requiredOn
    Backchannel logout revoke offline sessionsOff
  • Keys No configuration changes are needed in this section.
  • Credentials No configuration changes are needed in this section.
  • Roles No configuration changes are needed in this section.
  • Client scopes No configuration changes are needed in this section.
  • Sessions No configuration changes are needed in this section.
  • Advanced

    Advanced Settings

    FieldValue
    Access Token LifespanInherit from realm settings /
    5 Minutes
    Client Token IdleInherit from realm settings /
    0 Minutes
    Client Token MaxInherit from realm settings /
    0 Minutes
    Client Offline Token IdleInherit from realm settings / 30 Days
    Client Offline Token MaxInherit from realm settings / 60 Days
    OAuth 2.0 Mutual TLS Certificate Bound Access Tokens EnabledOff
    Proof Key for Code Exchange Code Challenge MethodS256
    Pushed authorization request requiredOff
    ACR to LoA Mapping[Default; do not add a mapping.]
    Default ACR Values[Leave blank; do not add values.]

    Authentication Flow Overrides

    FieldValue
    Browser FlowHYPR
    Direct Grant FlowHYPR
  1. Click Save.

©2003-2025 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.