Important
This repository contains the connector and configuration code only. The implementer is responsible for acquiring 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 Environment:
- Set up your HelloID environment.
- Exchange Online PowerShell V3 module:
- This HelloID Service Automation Delegated Form uses the Exchange Online PowerShell V3 module. A HelloID agent is required to import the Exchange Online module.
- Entra ID Application Registration:
- App registration with
API permissions
selectAPIs my organization uses
search forOffice 365 Exchange Online
. SelectApplication permissions
:Exchange.ManageAsApp
- The following information for the app registration is needed in HelloID:
Application (client) ID
Directory (tenant) ID
Secret Value
- App registration with
- Entra ID Role:
- The
Exchange Administrator
should provide the required permissions for any task in Exchange Online PowerShell.- To assign the role(s) to your application, navigate to
Roles and administrators
. - Search and select
Exchange Administrator
clickAdd assignments
. Select the app registration that you created in step 3. - Click
Next
, assignment typeActive
.
- To assign the role(s) to your application, navigate to
- The
- None at this time.
HelloID-Conn-SA-Full-Exchange-Online-SharedMailboxUpdate is a template designed for use with HelloID Service Automation (SA) Delegated Forms. It can be imported into HelloID and customized according to your requirements.
By using this delegated form, you can update a shared mailbox in Exchange Online. The following options are available:
- Search and select the shared mailbox
- Option to edit the shared mailbox
name
. - Option to edit the shared mailbox
alias
. - Option to edit the shared mailbox
primarySmtpAddress
. - A data source will
validate
the input in exchange online. If this is valid you can submit the form. - The task will
update
the shared mailbox
The ExchangeOnlineManagement
module provide a set of commands to interact with Exchange Online. The commands used are listed in the table below.
Endpoint | Description |
---|---|
Get-User | Required for Get-Mailbox / Set-Mailbox |
Get-Mailbox | To retrieve and validate the input in Exchange Online |
Set-Mailbox | To update the shared mailbox in Exchange Online |
The following options are available in the form:
- Search and select shared mailbox:
- Search and select the shared mailbox that needs to be updated.
- Edit and validate data:
- Edit one or more of the following properties:
name
,alias
orprimairysmtpaddress
. The Powershell data source willvalidate
the input in exchange online.
- Edit one or more of the following properties:
The following actions will be performed after submitting the form:
- Retrieve the shared mailbox in exchange online:
- The Get-Mailbox command will be used to get the current Aliases
- Updating the shared mailbox in exchange online:
- The Set-Mailbox command will be used to update the shared mailbox
The following user-defined variables are used by the connector. Ensure that you check and set the correct values required to connect to the API.
Setting | Description |
---|---|
EntraOrganization |
The name of the organization to connect to and where the Entra ID App Registration exists. |
EntraTenantId |
The ID to the Tenant in Microsoft Entra ID |
EntraAppId |
The ID to the App Registration in Microsoft Entra ID |
EntraAppSecret |
The Client Secret to the App Registration in Microsoft Entra ID |
Tip
For more information on Delegated Forms, 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/