Unity Service

The following configurations relating to the Unity Service can be made within Client Manager:

Allow the client to access the ADSS Unity Service.
Assign the Unity Profiles which can be accessed by this client.
Configure a default Unity Profile for this client.

Once a client is registered, permissions to access the Unity Service can be granted by editing this client. On the edit screen, clicking on the Unity Service link at the top of the page shows the following screen:

The configuration items are as follows:

Items

Description

Allow this client to access the ADSS Unity Service

Select the Allow this client to access the ADSS Unity Service checkbox to enable the client to send Unity Service requests to the ADSS Server. If the application also requires access to other ADSS services, such as generating and certifying user signing keys, ensure the necessary permissions are granted by enabling the relevant options (e.g., Certification Service).

Select Unity Profile

The next step is to specify which Unity profiles, configured within the ADSS Unity Service, should be accessible to this client. By default, all existing Unity profiles are available to any newly registered client. Since different clients may require access to specific Unity profiles, you can grant access by moving the desired profile from the Available Unity Profiles box on the left to the Selected Unity Profiles box on the right using the >> button, as shown in the screenshot. Clients can only utilize the Unity profiles listed in the Selected Unity Profiles box. To revoke access to a profile, use the << button to move it back to the Available Unity Profiles box.

Profile Usage Map

The Profile Usage Map button provides an overview of which profiles are being used by which clients.

Default Unity Profile

The Default Unity Profile defines which profile to use in case the request message from this client does not reference any specific Unity profile.

Allow this client to use any document signing key held in Key Manager

Select this option to allow the client application to access any document signing key stored in the ADSS Key Manager. The Key Manager serves as a centralized repository for all operator-generated or imported keys designated for document signing.

Only allow the selected signing keys held in Key Manager to be used by the client

Choose this option to restrict the client application to use only specific signing keys. Any keys not allowed for this client can be moved to the Available Keys box, ensuring controlled access.

Enable Service Plan for this Client

Enabling this option allows the client to access service plan configuration settings.

Transaction Limit

This field lets the operator define the maximum number of transactions the client can perform.

The value must range between 1 and 9,223,372,036,854,775,807. A value of '0' is not permitted.

Apply Transaction Limit by Request Type

This option allows the operator to set transaction limits based on specific request types. For the Unity Service, the available request types include:

Register User
Get Profile Info
Update User
Delete User
Get User
Get Users
Change Password
Change Password [BA]
Recover Password
Confirm Recover Password
Change Email
Confirm Change Email
Change Mobile
Confirm Change Mobile
Revoke Token
Key Generation
Key Delete
Get CSR
Import Certificate
Get Certificate
Unity Information
No Authentication
Basic Authentication
SAML Authentication
Revoke Token
List Credentials
Credential Authorise
Hash Signing
Timestamp
Document Signing
Credential Info
Get Challenge
Extend Transaction
Generate QR Code
Get User Certs
OAuth2 Authorize
OAuth2 Authorize[Post]
OAuth2 Token
OAuth2 Revoke
IdP Relegate
Credential Authorise Check
OAuth2 Pushed Authorize

Start From

Select the starting date when the service plan will be started.

Expire After

Define the duration after which the service plan will expire. Users can specify the expiry period by selecting a number of days, months, or years.

Send alerts when the service plan has expired

By enabling this checkbox, an alert will be sent to the client when the plan has expired.

Send alerts before this service plan expires

When enabled, this checkbox activates a field where the user can specify the number of days before the plan’s expiry to send an alert to the client.

Send alerts when transaction limit has been reached

Enabling this option sends an alert to the client when the transaction limit reaches a specified percentage, as defined by the user.

Auto-Renew service plan before expiry by

This option allows the user to configure automatic renewal of the service plan before its expiry by specifying a time frame in hours, days, or months.

Auto-Renew service plan when transaction limit is reached

Enabling this option sets the service plan to renew automatically once the transaction limit reaches the defined percentage.

Renew Service Plan

This button allows the user to manually renew the service plan. Note that this button is disabled if auto-renewal options are selected.

The alert checkboxes will trigger alerts only if the client has configured both an email address and a mobile number in general settings for the client.

A default Unity profile must be defined here, for the default Client configured inside Unity Service > Service Manager, in order to process the requests from client applications i.e. Go>Sign Mobile app or CSC v2 protocol etc.

Click the Save button when the list is updated to store the changes.

Whenever configurations are updated on this page remember to restart the Unity Service and have the changes take effect.