Data provisioning
Connector settings
For the Omada Exchange Online Connectivity, the following provisioning details need to be configured.
| Setting | Description |
|---|---|
| Connection URI | The URL for Exchange Online PowerShell. In order to find the appropriate URL for your Exchange Online organization, go to: Microsoft documentation and Outlook documentation |
| Authentication | The authentication protocol to use for provisioning. You can select: Certificate thumbprint Certificate with password |
| Username | Type the name of the username to use for provisioning. |
| Password | Type the password of the user if you have entered a username in the field above. |
| Session options | Advanced options for the PowerShell session. Go here for list of options. -SkipCACheck -SkipCNCheck -SkipRevocationCheck |
| Always enforce the email address policy | Ensures that all provisioned mailboxes in Exchange is set to follow the current email address policy. |
| Extension script file | Specifies a PowerShell file. You must place the file in the OPS installation folder. |
| Test connection | Enable this setting to test the connection information that you have specified. If you want to use this functionality must install Omada Provisioning Service and make sure it has the necessary permissions to communicate with the target system. |
| Organization | Specifies the organization that is used. Be sure to use an .onmicrosoft.com domain for the parameter value. |
| Application ID | Specifies the application ID of the service principal that's used in certificate based authentication. |
| Certificate thumbprint | Specifies the thumbprint value of the certificate used for certificate based authentication. Available only when the Certificate thumbprint is selected in the Authentication field. |
| Certificate (PEM format) | Specifies the certificate used. The value should be enclosed with -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. |
| Private key (PEM format) | Specifies the private key used. The value should be enclosed with -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. |
| Private key password | Specify password for private key used for certificate based authentication. |
| Remote domain | Specify the domain in which SMTP address remote mailboxes will be created. |
Data model
The Data model for Microsoft Exchange Online Connectivity supports the following objects:
- MailboxAccess
- SharedMailbox
- RoomMailbox
- EquipmentMailbox
- DistributionGroup
- DistributionGroupAssignment
Task mappings
The bundledAttributes can be used to set any of the parameters supported by Set-Mailbox, New-Mailbox, Set-RemoteMailbox, New-RemoteMailbox, New-DistributionGroup, and Set-DistributionGroup command.
For more information, check the following sources:
MailboxAccess
The MailboxAccess object is used to create, update, and delete access permissions of a user to another user's mailbox. Supported properties:
| Property | Type | Description |
|---|---|---|
| Identity | stringType | Specifies the identity of the mailbox that permissions are assigned to. Use any value that uniquely identifies the user. |
| mailboxPermission | stringType | Permission access level that one user can have to another user’s mailbox. Three permission levels supported out of the box: Full Access, Send As, and Send on Behalf. |
| userMailboxGuid | stringType | Specifies the user mailbox that the permissions are being granted to on the other mailbox. The latter indicated by the identity property. |
SharedMailbox
The SharedMailbox object is used to create, update, and delete shared mailboxes. Supported properties:
| Property | Type | Description |
|---|---|---|
| Identity | stringType | Specifies the target mailbox user. You can use any value that uniquely identifies the user. |
| Name | stringType | Specifies the resource name visible in the address book. |
| DisplayName | stringType | Specifies the name that is shown in the address book and in the To and From lines when an email is sent from and to this mailbox. |
| Alias | stringType | Specifies the beginning of an email address preceding the @ symbol. |
| bundledAttributes | stringType | bundledAttributes is an OPS Generic PowerShell Connector feature. |
RoomMailbox
The RoomMailbox object is used to create, update, and delete room mailboxes. Supported properties:
| Property | Type | Description |
|---|---|---|
| Identity | stringType | Specifies the target mailbox user. You can use any value that uniquely identifies the user. |
| Name | stringType | Specifies the resource name visible in the address book. |
| DisplayName | stringType | Specifies the name that is shown in the address book and in the To and From lines when an email is sent from and to this mailbox. |
| Alias | stringType | Assigns an alias (also called mail nickname) to a room mailbox. |
| bundledAttributes | stringType | bundledAttributes is an OPS Generic PowerShell Connector feature. |
EquipmentMailbox
The EquipmentMailbox object is used to create, update, and delete room mailboxes. Supported properties:
| Property | Type | Description |
|---|---|---|
| Identity | stringType | Specifies the target mailbox user. You can use any value that uniquely identifies the user. |
| Name | stringType | Specifies the resource name visible in the address book. |
| DisplayName | stringType | Specifies the name that is shown in the address book and in the To and From lines when an email is sent from and to this mailbox. |
| Alias | stringType | Assigns an alias (also called mail nickname) to a equipment mailbox. |
| bundledAttributes | stringType | bundledAttributes is an OPS Generic PowerShell Connector feature. |
DistributionGroup
The DistributionGroup object is used to create, update, and delete distribution groups. Supported properties:
By default, there is only one query for distribution groups. To onboard distribution groups and separately mail-enabled security groups, apply additional filtering. Use the Type property - set it to SecurityEnabled to provision mail-enabled groups.
| Property | Type | Description |
|---|---|---|
| Identity | stringType | Specifies the group that you want to modify. You can use any value that uniquely identifies the group. |
| Name | stringType | Specifies the unique name of the group. |
| DisplayName | stringType | Specifies the display name of the group. |
| Alias | stringType | Specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object. |
| Type | stringType | Specifies the type of group that you want to create. |
| bundledAttributes | stringType | bundledAttribute is an OPS Generic PowerShell Connector feature. |
DistributionGroupAssignment
The DistributionGroupAssignment object is used to create, update, and delete distribution group members. Supported properties:
| Property | Type | Description |
|---|---|---|
| Identity | stringType | Specifies the group that you want to modify. You can use any value that uniquely identifies the group. |
| distributionGroupGuid | stringType | The unique identifier for this object. |
Attribute names between DataModel and taskMappings are case-sensitive.