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-SSRPM-Onboarding is a target connector. SSRPM-Onboarding provides a set of REST API's that allow you to programmatically interact with its data.
It imports "Onboarding" information for the specific user into SSRPM. This allows a user that wants to enroll in ssrpm, but does not know their AD account information, an alternative method of enrolling in ssrpm
An installed and configured ssrpm web site. The OnboardingToken must be specified int the Web.config file of the SSSRPM website. This token kan be generated in the SSRPM Management console.
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
|---|---|---|
| Token | The onboarding API token to connect to the API | Yes |
| BaseUrl | The URL to the API | Yes |
The correlation configuration is used to specify which properties will be used to match an existing account within SSRPM-Onboarding to a person in HelloID. For this connector no correlation is done, because the interface does not support "get" operations, and the correlation settins are ignored.
| Setting | Value |
|---|---|
| Enable correlation | false |
| Person correlation field | not applicable |
| Account correlation field | not applicable |
Tip
For more information on correlation, please refer to our correlation documentation pages.
The following lifecycle actions are available:
| Action | Description |
|---|---|
| create.ps1 | Imports SSRPM onboarding information pertaining to an AD user Account. With this information the end user is later able to enroll in SSRPM by means of the onboarding method |
The field mapping can be imported by using the fieldMapping.json file. These contains
This connector does not have a genuine lifecycle, there is only a create script that imports onboarding information into SSRPM. This connector only performs the "import" part of the onboarding process, which enables the end-user to complete the onboarding process by useing the SSRPM web site.
The following endpoints are used by the connector:
| Endpoint | Description |
|---|---|
| /onboarding/import |
Detailed information about the complete onboarding process can be found in the chapter about Onboarding in the "/Admin Console/Documentation/Web Interface Guide.pdf" that comes with the SSRPM installation.
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/