Important
This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements.
- HelloID-Conn-Prov-Target-Caseware
HelloID-Conn-Prov-Target-Caseware is a target connector. Caseware provides a set of REST API's that allow you to programmatically interact with its data.
The following features are available:
| Feature | Supported | Actions | Remarks |
|---|---|---|---|
| Account Lifecycle | ✅ | Create, Update, Enable, Disable, Delete | |
| Permissions | ❌ | - | |
| Resources | ❌ | - | |
| Entitlement Import: Accounts | ✅ | - | |
| Entitlement Import: Permissions | ✅ | - | |
| Governance Reconciliation Resolutions | ✅ | - |
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
|---|---|---|
| ClientId | The UserName to connect to the API | Yes |
| ClientSecret | The Password to connect to the API | Yes |
| BaseUrl | The URL to the API | Yes |
| CustomerId | The id or name of the customer | Yes |
The correlation configuration is used to specify which properties will be used to match an existing account within Caseware to a person in HelloID.
| Setting | Value |
|---|---|
| Enable correlation | True |
| Person correlation field | PersonContext.Person.Account.Microsoft.ActiveDirectory.Email |
| Account correlation field | Email |
Tip
For more information on correlation, please refer to our correlation documentation pages.
The field mapping can be imported by using the fieldMapping.json file.
The account reference is populated with the property CWGuid property from Caseware
Within the create lifecycle action, initial validation and correlation of the user account is based on the email attribute. The accountReference will be the CWGuid property.
This connector does not create new accounts. The create lifecycle actions only performs account correlation. Subsequently; the $actionContext.DryRun logic has been removed.
When performing an update, the OwnerType field must be present and valid in the payload.
There's no property to enable or disable the user account. Caseware does provide a CanLogin property. However, its not possible to change the value of this property since its tied directly to an external user synchronization.
Groups are assigned through roles. Just like users, roles also have a CWGuid. This GUID is used when assigning and removing roles. However, the id of a role is what you will find on a user in the field FirmWideRoleIds. These ids correspond to the ids associated with a role.
The following endpoints are used by the connector
| Endpoint | Description |
|---|---|
| {baseUrl}/ms/caseware-cloud/api/v2/auth/token | Retrieve oAuth token |
| {baseUrl}/ms/caseware-cloud/api/v2/users | User related actions |
| {baseUrl}/ms/caseware-cloud/api/v2/users/:id/role-assignments | Grant / revoke role |
| {baseUrl}/ms/caseware-cloud/api/v2/roles | Retrieve available roles |
Tip
For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages.
Tip
If you need help, feel free to ask questions on our forum.
The official HelloID documentation can be found at: https://docs.helloid.com/