A client secret is a random string known only to the external client application and the authorization server. A client connection in Hyland IdS can be configured to only accept connections from external client applications that have the secret.
For enhanced security, client secrets should be encrypted. See Encrypting Client Secrets and API Secrets for more information. To provide an extra layer of security, Hyland Identity Service (IdS) encrypts client secrets and API secrets using the Hyland Application Settings Utiltity (HASU). See Encrypting Client Secrets and API Secrets for more information.
The value of a configured client secret cannot be changed after it is saved. To change the value of an existing client secret, it must be added as a new value. See also, Deleting a Client Secret.
To configure client secrets for a client connection in Hyland IdS:
-
Launch the Hyland IdS Administration client and
log in (see Accessing the Hyland IdS 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 Clients tab to view the client connections
currently configured for the tenant.
The number of client connections configured is displayed in parentheses in the tab heading.
-
In the Clients list, click the name of the client connection you want to configure client secrets for.
The Client configuration page is displayed. It is divided into several areas.
In a wide display, the Client Secrets area is displayed on the right of the page. In a narrow display, click the Client Secrets tab to display the Client Secrets area.
-
Click Add New to the right of the Client
Secrets tab.
The Create Secret dialog box is displayed.
-
Configure the following options in the Create Secret
dialog box.
Option
Description
Set Client Secret Value
The option to generate a secret value. If you do not select this option, then the client secret is automatically generated. Description
A brief description to help identify this client secret, used mostly for logging purposes.
Value
The plain-text value of the word or phrase configured as the client secret for the external client application.
Note: This value is required if you select the Set Client Secret Value option.If the Set Client Secret Value option is not selected, the value is automatically generated once you select the Create Secret button. Else, plain-text value of the word or phrase configured as the client secret for the external client application should be provided. The entered or auto-generated value is converted into a hash when the client connection is saved, but the value sent from the client application must remain in plain text.
Note: The client secret value should be at least 8 characters to ensure sufficient security. The secret value, whether it is provided or auto-generated, is displayed only once during client creation.Expiration
The date after which the client secret value has to be updated.
Enter the date in M/D/YYYY format, or select it from the graphical calendar by clicking the calendar icon at the right end of the Expiration field.
Type
The source of the client secret value:
-
Shared Secret
-
X509 Thumbprint
-
X509 Name
-
X509 Certificate Base64
Tip:In most cases, you should use Shared Secret.
-
-
Click Create Secret.
The client secret is created and the Create Secret dialog box automatically transitions to the View Secret Details dialog box, where you can modify the fields for the secret you just created.
- Close the View Secret Details dialog box to return to the Client Secrets tab.
- Click Save in the lower right corner of the page.
- Recycle the application pool of Hyland IdS in IIS for the changes to take effect.