This type of provider uses OIDC-Exchange to authenticate users and log them in.
Detailed instructions on how to configure an OIDC-Exchange environment to correctly authenticate and return valid tokens for use with the Hyland IdP server are beyond the scope of this documentation. Detailed instructions for configuring your provider are available from the developer of the software being used.
To configure the Hyland IdP server to use OIDC-Exchange:
Launch the Hyland IdP Administration client and log in (see Accessing the Hyland IdP Administration Client).
Upon successfully logging in, the tenant, provider, client connection, and API resource information is displayed. In a wide display, the tenant information is in the left pane and the providers, client connections, and API resources configured for that tenant are listed in the right pane. In a narrow display, the tenant information is at the top of the page and the provider, client connection, and API resource information is below it.
Click the Provider tab to view the providers currently configured for the tenant. The number of providers configured is displayed in parenthesis in the tab heading.
If this is a new provider, click Add New at the upper right of the providers list.
If you are configuring an existing provider, click its name in the list of providers.
The Provider configuration page is displayed. It is divided into the Basic Settings and Protocol areas. In a wide display, the Basic Settings area is on the left. In a narrow display, the Basic Settings area is at the top of the page.
- Under Protocol, select OIDC-Exchange from the Type drop-down list. The specific settings for OIDC-Exchange providers are displayed.
Under Basic Settings, configure the following options.
A unique name for the provider. This value is required and cannot contain any slashes (/ or \).
User Attribute Mapping
These settings are used to synchronize user attribute information.
The schema definitions of the provider responses that contain the account declarations of the user logging in. The following attributes can be synchronized.
UserId: The unique user identifier received from the external provider. This can be configured to use the username if the username does not change over time. This attribute is required.
Username: The URI of the claim type in the provider response that contains the user name of the user logging in. This attribute is required.
Email: The URI of the claim type in the provider response that contains the email address of the user logging in.
Real Name: The URI of the claim type in the provider response that contains the real name of the user logging in.
Group: The URI of the claim type in the provider response that contains the group membership of the user logging in.
Strip domain from username
Select this option to remove the domain from the user name before it is passed for authentication.
This setting controls whether to automatically strip the domain from user names that are passed as either domain\username or username@domain. This is useful when providers use a full domain and user name but authenticating system only uses the user name.
Enable User Provisioning
Select this option to synchronize the user attributes defined in the User Attribute Mapping section when the user logs in.
User Provisioning Create Enabled
Select this option to allow creating a new user in the tenant resource if the user logging in is not found.
If this option is not selected and the user logging in is not found, that user is not logged in and an exception is returned.
User Provisioning Update Enabled
Select this option to allow updating an existing user in the tenant resource if the user logging in is found.
If this option is not selected, the incoming user information from the tenant is ignored and no updates are made to user information.
Update the values of the OIDC-Exchange settings to match your environment.
Enter the URL for the issuer of incoming ID tokens. This is the expected value of the iss claim within an incoming token.
This value will be used to look up the specific provider for this tenant. The client submitting the ID token must also belong to the same tenant.
Cache Duration in Seconds
Enter the duration, in seconds, to retain the results of calls to locations in either the Issuer or JWKS Uri setting.
The default setting is 14400 seconds (4 hours).
To prevent caching results, enter 0 (zero).
Enter the URI for the endpoint to call for JSON Web Key Set (JWKS) signing data.
Enter the allowed keys for the JSON Web Key Set (JWKS) endpoint in JWKS format.Note:
JSON Web Key Set format is an internet standard. For more information, see the specifications published by the Internet Engineering Task Force (IETF).
Note the following on how these settings are used to get signing keys to validate tokens:
If values for both JKWS Uri and JWKS Document are included, only JWKS Document is used.
If JWKS Document is not included, JKWS Uri is used.
If neither JKWS Uri or JWKS Document is included, the Issuer URL is used.
Click Save in the lower right corner of the page.
If you are configuring the Hyland IdP for use with an OnBase environment, you must also configure a default User Group in OnBase to assign new users to when accounts are created in OnBase from federated credentials.