Chat now with support
Chat with Support

Active Roles 7.5.2 - Administration Guide

Introduction About Active Roles Getting Started Rule-based Administrative Views Role-based Administration
Access Templates as administrative roles Access Template management tasks Examples of use Deployment considerations Windows claims-based Access Rules
Rule-based AutoProvisioning and Deprovisioning
About Policy Objects Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning E-mail Alias Generation Exchange Mailbox AutoProvisioning AutoProvisioning for SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Office 365 and Azure Tenant Selection User Account Deprovisioning Office 365 Licenses Retention Group Membership Removal Exchange Mailbox Deprovisioning Home Folder Deprovisioning User Account Relocation User Account Permanent Deletion Group Object Deprovisioning Group Object Relocation Group Object Permanent Deletion Notification Distribution Report Distribution
Deployment considerations Checking for policy compliance Deprovisioning users or groups Restoring deprovisioned users or groups Container Deletion Prevention policy Picture management rules Policy extensions
Workflows
Understanding workflow Workflow activities overview Configuring a workflow
Creating a workflow definition Configuring workflow start conditions Configuring workflow parameters Adding activities to a workflow Configuring an Approval activity Configuring a Notification activity Configuring a Script activity Configuring an If-Else activity Configuring a Stop/Break activity Configuring an Add Report Section activity Configuring a Search activity Configuring CRUD activities Configuring a Save Object Properties activity Configuring a Modify Requested Changes activity Enabling or disabling an activity Enabling or disabling a workflow Using the initialization script
Example: Approval workflow E-mail based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic Groups Active Roles Reporting Management History
Understanding Management History Management History configuration Viewing change history
Workflow activity report sections Policy report items Active Roles internal policy report items
Examining user activity
Entitlement Profile Recycle Bin AD LDS Data Management One Identity Starling Management One Identity Starling Two-factor Authentication for Active Roles Managing One Identity Starling Connect Azure AD, Office 365, and Exchange Online management
Configuring Active Roles to manage hybrid AD objects Managing Hybrid AD Users Unified provisioning policy for Azure O365 Tenant Selection, Office 365 License Selection, and Office 365 Roles Selection, and OneDrive provisioning Office 365 roles management for hybrid environment users Managing Office 365 Contacts Managing Hybrid AD Groups Managing Office 365 Groups Managing Azure Security Groups Managing cloud-only Azure users Managing cloud-only Azure guest users Managing cloud-only Azure contacts Changes to Active Roles policies for cloud-only Azure objects Managing room mailboxes
Managing Configuration of Active Roles
Connecting to the Administration Service Adding and removing managed domains Using unmanaged domains Evaluating product usage Creating and using virtual attributes Examining client sessions Monitoring performance Customizing the console Using Configuration Center Changing the Active Roles Admin account Enabling or disabling diagnostic logs Active Roles Log Viewer
SQL Server Replication Appendix A: Using regular expressions Appendix B: Administrative Template Appendix C: Communication ports Appendix D: Active Roles and supported Azure environments Appendix E: Enabling Federated Authentication Appendix F: Active Roles integration with other One Identity and Quest products Appendix G: Active Roles integration with Duo Appendix H: Active Roles integration with Okta

Office 365 automation workflow

To import Azure or O365 Windows PowerShell modules, and run their corresponding O365 services within existing Active Roles workflows, configure O365 automation workflows. These workflows support running scripts from the following Windows PowerShell modules:

  • Microsoft Teams

  • Azure AD

  • Azure Az

  • Exchange Online Management

Creating a new O365 automation workflow has the following steps:

  1. In the Configuration > Script Modules node of the Active Roles Console (also known as the MMC Interface), create the new O365 script that you want to run with the new O365 automation workflow.

  2. In the New Workflow wizard, configure the new O365 automation workflow.

  3. With the O365 script execution configuration activity of the Workflow Designer, specify the Azure tenant to which the configured workflow will apply.

  4. Import the new O365 script into the workflow created in the first step.

NOTE: By default, Active Roles does not select any Azure tenants automatically after you configured a new workflow with the New Workflow wizard. After the workflow is created, configure one in the Workflow Editor, otherwise the workflow will fail with the following error message:

Select a configured Azure tenant from the Select a Tenant to configure O365 Services drop-down list. Alternatively, under Parameter values, provide a valid Tenant ID, Tenant Name, Application (Client) ID and Application (Client) Certificate Thumbprint to override Azure tenant details from the workflow.

For more information on how to configure an O365 automation workflow, see Creating an Office 365 automation workflow. For a list of sample O365 workflow scripts, see Sample Office 365 workflow scripts.

Creating an Office 365 automation workflow

To import Azure or Office 365 Windows PowerShell modules, and run their scripts within existing Active Roles workflows, configure an Office 365 (O365) automation workflow.

Prerequisites

Before starting the configuration of an O365 automation workflow, make sure that the following conditions are met:

  1. The following Windows PowerShell modules are installed on the system running Active Roles:

    • Microsoft Teams

    • Azure AD

    • Azure Az

    • Exchange Online Management

    If these PowerShell modules are not installed, Active Roles cannot run workflows that include O365 PowerShell script execution activities.

    NOTE: Consider the following when planning to use the Exchange Online Management module:

    • To run a Sample Azure Hybrid Migration script, an on-premises Microsoft Exchange deployment must be available.

    • As Exchange Online is connected to Exchange Online PowerShell, make sure that the https://outlook.office365.com/powershell-liveid/ URL is not blocked in your organization domain, and that network connectivity is available.

  2. You already created the O365 script module to use as a script activity with the O365 automation workflow. For more information, see Script activity.

To create an Office 365 automation workflow

  1. In the Active Roles Console (also known as the MMC Interface), expand Configuration > Policies.
  2. To launch the New Workflow wizard, right-click Workflow, and select New > Workflow in the context menu.
  3. On the Name and Description page, enter a Name and optionally, a Description for the new workflow.
  4. On the Workflow Type page, under This workflow is intended to start, select On user demand or on a scheduled basis (automation workflow).
  5. On the Completion page, click Finish.
  6. To configure the Azure tenant connection settings of the new O365 automation workflow, double-click the workflow to open the Workflow Designer, then click Basic Activities > O365 script execution configuration.

  7. Specify the Azure tenant with one of the available methods:

    • Under Select a Tenant to configure O365 Services, select the Azure tenant you want to use with the automation workflow. This setting lists all Azure tenants that are configured in the Active Roles Configuration Center, as described in Configuring a new Azure tenant and consenting Active Roles as an Azure application.

    • Alternatively, to provide the Azure tenant connection details manually, click the parameters under Parameter values, and specify the Tenant ID, Tenant Name, Application (Client) ID, and Application (Client) Certificate Thumbprint of the Azure tenant as they appear on the Azure portal.

      NOTE: Providing the Azure tenant details manually overrides the selection of the Select a Tenant to configure O365 Services drop-down list.

    To apply your changes, click OK.

  8. To specify the O365 script to use in the workflow, click Basic Activities > Script.

  9. In the Script Activity window, in the General tab, specify the Name (and optionally, the Description) of the O365 script.

  10. To select the O365 script to use in the automation workflow, click Script to use > Browse, then select your O365 script in the Script Modules tree.

  11. To apply your changes, click OK.

NOTE: The configured workflow will run successfully only if the specified script is well-formed and complete.

Sample Office 365 workflow scripts

This section contains Office 365 (O365) workflow script samples for reference.

$context.O365ImportModules(@(array-of-modules))

The O365ImportModules function lets you load an array of Azure and O365 Windows PowerShell modules. The function supports loading the following modules:

  • Microsoft Teams

  • Azure AD

  • Azure Az

  • Exchange Online Management

Once the modules are loaded, the function creates a connection to the specified modules with the connection details specified in the O365 script execution configuration workflow activity. For more information, see Creating an Office 365 automation workflow.

Example: Importing all supported Azure and O365 Windows PowerShell modules

In this example, the O365ImportModules function is used to import all Windows PowerShell modules that O365 automation workflows support. After that, one command is invoked for each imported PowerShell module, respectively.

function TestImportAll() {
   $context.O365ImportModules(@("Az", "AzureAD", "ExchangeOnlineManagement", "MicrosoftTeams"))
				
   Get-AzureADApplication -Filter "DisplayName eq 'ActiveRoles'" | ConvertTo-Json | Out-File -FilePath C:\WS\Files\AzureAD.txt
   Get-AzContext | ConvertTo-Json | Out-File -FilePath C:\WS\Files\Az.txt
   Get-EXOMailbox -Identity ExampleUser | ConvertTo-Json | Out-File -FilePath C:\WS\Files\ExchangeOnlineManagement.txt
   Get-TeamUser -GroupId "741731d3-c813-4c98-92db-0b9c334cb4bc" | ConvertTo-Json | Out-File -FilePath C:\WS\Files\MicrosoftTeams.txt
}
$context.O365ImportModule (module)

The O365ImportModule function lets you load a single O365 or Azure Windows PowerShell module. If you have multiple versions of the specified module installed, you can also specify the module version to load.

NOTE: The O365ImportModule function supports specifying major module versions only (such as version 2.x).

Example: Importing the Azure AD PowerShell module

In this example, the O365ImportModule function is used to import version 2.x of the Microsoft Azure AD Windows PowerShell module.

function TestImportTeamsModule() {
   $context.O365ImportModule("AzureAD", 2)
}
$context.O365ExecuteScriptCmd(string-or-cmd )

The O365ExecuteScriptCmd function passes any string or command specified in the script, then runs and returns the results as a PSObject.

$context.O365RemoveAllModulesSessions()

The O365RemoveAllModulesSessions script disconnects all PSSessions and removes all modules from the PowerShell pool, allowing Active Roles to import new modules again.

Example: Removing all Windows Powershell module sessions

In this example, the O365RemoveAllModulesSessions function is used to disconnect the PSSession related to a previously loaded AzureAD module, and then remove the AzureAD module from the PowerShell pool.

#Get a list of disabled users and Directory Roles available
        $_usersinroles= @()
        $_default_log = "C:\temp\Roles.csv"
        $context.O365ImportModule("AzureAD")
        $context.O365ExecuteScriptCmd("get-azureaduser -filter 'accountEnabled eq false'" +" | Export-Csv " +"c:\temp\DisabledUsers.csv" +" -NoTypeInformation")
        $context.O365ExecuteScriptCmd("Get-AzureADDirectoryRole | Export-csv "+$_default_log )
        $context.O365RemoveAllModulesSessions()

Creating Office 365 shared mailboxes

To create new Office 365 shared mailboxes, use the Create Office 365 Shared Mailboxes built-in workflow. This workflow uses two other built-in resources:

  • The O365 script execution configuration activity.

  • The Create Office 365 Shared Mailboxes script.

By default, the Create Office 365 Shared Mailboxes workflow is disabled, as One Identity recommends using it as a template for custom workflows that uses the required values in the script, such as Mailbox name, Mailbox display name, Alias, and recipients to grant the Send As permission.

The Create Office 365 Shared Mailboxes workflow is located in the Configuration > Policies > Workflow > Builtin container of the Active Roles Console (also known as the MMC interface). The required Create Office 365 Shared Mailboxes script is located in the Configuration > Policies > Script Modules > Builtin container.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating