ℹ️ Information |
---|
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. |
The HelloID-Conn-Prov-Target-Spacewell-Axxerion is a facility management suite and provides a set of REST API's that allow you to programmatically interact with it's data.
The following settings are required to connect to the API.
Setting | Description |
---|---|
Username | The username of the user who has rights to access the API |
Password | The password for the user who has rights to access the API |
BaseUrl | The URL to the Spaxewell Axxerion environment |
Customer | The customer name. (This is the same name as the in the URL) |
The _HelloID-Conn-Prov-Target-Spacewell-Axxerion connector is built for both Windows PowerShell 5.1 and PowerShell Core 7. This means the connector can be executed using the On-Premises HelloID agent as well as in the cloud.
All PowerShell files (apart from the 'entitlements.ps1' file) use a json body that has a datasource specified. For instance, the create.ps1 on line 66.
$body = @{
datasource = 'HelloID'
clobMBValue = $clobMBValue
} | ConvertTo-Json
This body is converted to JSON, since the full body that will be send to Axxerion Spacewell must be a JSON containing a nested JSON string. The 'datasource' is set to 'HelloID'.
The entitlements.ps1 also needs a body containing a nested JSON string. See line 43.
$body = @{
"reference" = "[company_name]-HELLOID-GetGroups"
} | ConvertTo-Json
This body contains a property called "reference" which must be set to '[company_name]-HELLOID-GetGroups' the [company_name] is different for each implementation. You will need to verify the correct name with your Axxerion consultant.
For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages
If you need help, feel free to ask questions on our forum
The official HelloID documentation can be found at: https://docs.helloid.com/