Configuring the External Access Client to Use IdP Authentication - Identity and Access Management Services - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - external

Integrating With Hyland IAM Services
Platform
OnBase
Product
Identity and Access Management Services
Release
Foundation 23.1
License

The External Access Client can only use Hyland IdP authentication if the Portal Type is set to Internal User. For complete information on configuring the External Access Client, see the External Access Client module reference guide.

Note:

The External Access Client requires the OnBase Application Server to communicate with OnBase. You must also configure the Application Server to use IdP authentication. See Configuring the Application Server to Use IdP Authentication.

To configure the External Access Client to use the Hyland IdP server for authentication:

  1. Configure a client connection on the Hyland IdP server for the External Access Client to use.
    Tip:

    Complete details on configuring a client connection on the Hyland IdP server are documented in the separate Identity and Access Management Services documentation. Version compatibility with OnBase Foundation releases is documented in the Version section of that documentation.

    The client connection must have the following settings, as well as any standard required settings. All other settings can be left with the default values.

    Setting

    Value

    Protocol Type

    oidc

    Redirect URLs

    The Login.aspx page of the External Access Client. This value is case sensitive.

    For example, if your domain is my.domain, the External Access Client application name is ExternalAccessClient, and the environment is configured for secure connections, then the value is: https://my.domain/ExternalAccessClient/Account/Login.aspx

    Allowed Grant Types

    • Authorization Code

    • Password

    Allowed Scopes

    • openid

    • profile

    • evolution

    Post Logout Redirect URLs

    The Logout.aspx page of the External Access Client. This value is case sensitive.

    For example, if your domain is my.domain, the External Access Client application name is ExternalAccessClient, and the environment is configured for secure connections, then the value is: https://my.domain/ExternalAccessClient/Logout/Logout.aspx

    Pkce

    Do not select Require PKCE

    Secret

    Select Client Secret must be present

  2. Configure a client secret with a Value that is the plain-text value of the word or phrase configured as the client secret for the External Access Client, and set the Type to Shared Secret.
    Note:

    The value entered is converted to a hash of the value when the client connection is saved, but the value passed from the External Access Client must still be plain text.

  3. Save the client connection. The Client ID value is automatically populated.
  4. Copy the Client ID value to the clipboard by clicking the icon at the right of the Client ID field.
    Tip:

    Recycle the application pool of the Hyland IdP server in IIS for any configuration changes on the Hyland IdP server to take effect.

  5. Open the web.config file of the External Access Client for editing in a plain-text editor. In a default installation, this file is located at C:\inetpub\wwwroot\ExternalAccessClient.
  6. Locate the EnableAutoLogin key under the appSettings element and set the value to true.
  7. Locate the idpUrl key under the appSettings element.
  8. Construct a URL that contains the following elements in the following order. Separate each element with a semi-colon (;).

    • The base URL of the Hyland IdP server. For example, if your domain is my.domain, the Hyland IdP application name is identityprovider, and the environment is configured for secure connections, then the value is: https://my.domain/identityprovider

    • The name of the Hyland IdP server tenant to use. This value is case sensitive and must match exactly the tenant name on the Hyland IdP server.

    • The unique ID of the client connection to use on the Hyland IdP server. This is the value you copied from the Hyland IdP server. The value is case sensitive and must match exactly the value on the Hyland IdP server.

    • The plain-text word to use as the client secret. This value is required.

      Note:

      You must also configure the corresponding client secret for the client connection on the Hyland IdP server. Complete details on configuring a client secret for a client connection on the Hyland IdP server are documented in the separate Identity and Access Management Services documentation. Version compatibility with OnBase Foundation releases is documented in the Version section of that documentation.

    For example, a completed URL using the examples from the list, with secret as the client secret word, will look similar to this:

    https://my-domain/identityprovider;TenantName;1735f48f-88d9-45bf-bd1b-6e74a448cecc;secret
  9. Enter the URL you constructed as the value of the idpUrl key.
  10. Save and close the web.config file.
  11. Recycle the application pool of the External Access Client for the changes to take effect.