Cyware Orchestrate

To configure the app, begin by running the provided PowerShell script on your local system. Before executing the script, ensure you replace the following placeholder parameters in the script with appropriate values or use None if not applicable: 

After setting the parameters, run the provided PowerShell script on your system.

# Replace the below parameters with a value
$CertPass = "YOUR_CERTIFICATE_PASSWORD"
$Days = 180
$b64_path = "NAME_OF_THE_TEXT_FILE_TO_BE_SAVED"+".txt"
$public_key_cert_path = "NAME_OF_THE_CERTIFICATE"+".cer"
# -------------------------------------------------------------

Install-Module -Name SelfSignedCertificate -Force
$pfx_path = "certificate.pfx"
Import-Module SelfSignedCertificate *> $null 2>&1
$Password = ConvertTo-SecureString $CertPass -AsPlainText -Force

$cmd_args = @{
    "OutCertPath" = $pfx_path
    "NotAfter"    = (Get-Date).AddDays($Days)
    "Password"    = $Password
}

try {
    New-SelfSignedCertificate @cmd_args -WarningAction:SilentlyContinue *> $null 2>&1
    openssl pkcs12 -in $pfx_path -out $public_key_cert_path -nokeys -clcerts -password pass:$CertPass *> $null 2>&1

    $File = [System.IO.File]::ReadAllBytes($pfx_path);
    $base_64_encoded = [System.Convert]::ToBase64String($File);
    [System.IO.File]::WriteAllText($b64_path, $base_64_encoded) *> $null 2>&1

    $success_text = "Certificate created" | ConvertTo-Json
    Write-Output($success_text) 
}
catch {

    Write-Error "An error occurred: $_" 

}

The script generates the following files:

Go to the Azure portal and either select an existing app or create a new one. To create a new app, see Microsoft Exchange Online Powershell documentation.

To upload the certificate, go to Owned applications under the Apps registration page. Select your application and go to Manage > Certificates & Secrets > Certificates, click Upload certificate, and upload the .cer file generated in step 1.

Go to Manage > API permissions and grant the required API permissions. For more information, see Microsoft Exchange Online Powershell documentation.

To modify the manifest file, select Manifest from the Manage section. In the app code, replace the key requiredResourceAccess and its associated value with the following code snippet: 

"requiredResourceAccess": [
    {
        "resourceAppId": "00000002-0000-0ff1-ce00-000000000000",
        "resourceAccess": [
            {
                "id": "dc50a0fb-09a3-484d-be87-e023b12c6440",
                "type": "Role"
            }
        ]
    },
    {
        "resourceAppId": "00000003-0000-0000-c000-000000000000",
        "resourceAccess": [
            {
                "id": "e1fe6dd8-ba31-4d61-89e7-88639da4683d",
                "type": "Scope"
            }
        ]
    }
],

Click Save to save your changes.

To verify if the permissions are correctly granted, go to Manage > API permissions. On the API permissions page, ensure that Office 365 Exchange Online is listed. Under it, confirm that Exchange.ManageAsApp is included with the following details:

The application needs the appropriate roles for proper access and functionality. Since the apps are provisioned in Microsoft Entra ID, you can assign one or more of the supported built-in roles. To assign Microsoft Entra roles, search roles and administrators, select Microsoft Entra roles and administrators, and then select the required options from the following roles:

For more information about the access levels of the Microsoft Entra roles, see Microsoft Exchange Online Powershell documentation.

To add an assignment, go to Manage > Assignments > Add assignments. Search for and select the app you created or selected in step 2, then click Add. Refresh the page to confirm if the app has been successfully added.

To communicate with the app, you must create an instance in Cyware Orchestrate. 

Sign in to Orchestrate, go to Main Menu > Apps > Appstore, and search for Microsoft Exchange Online PowerShell. 

Click on the app and install the latest version. Go to Instances, click the plus icon to create an instance for the selected version, and use the following information:

Click Create. To test the app instance and verify the connection, hover over the instance, and click Test Instance.