Chat now with support
Chat with Support

Active Roles 8.1.1 - Administration Guide

Introduction 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
Provisioning Policy Objects Deprovisioning Policy Objects How Policy Objects work Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning Exchange Mailbox AutoProvisioning AutoProvisioning in SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Microsoft 365 and Azure Tenant Selection E-mail Alias Generation 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
Using rule-based and role-based tools for granular administration Workflows
Key workflow features and definitions About workflow processes Workflow processing overview Workflow activities overview Configuring a workflow
Creating a workflow definition for a workflow Configuring workflow start conditions Configuring workflow parameters Adding activities to a workflow Configure 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
Approval workflow Email-based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic groups Active Roles Reporting Management History Entitlement profile Recycle Bin AD LDS data management One Identity Starling Join and configuration through Active Roles Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users Azure AD, Microsoft 365, and Exchange Online Management
Configuring Active Roles to manage Hybrid AD objects Managing Hybrid AD users
Creating a new Azure AD user with the Web Interface Viewing or updating the Azure AD user properties with the Web Interface Viewing or modifying the manager of a hybrid Azure user Disabling an Azure AD user Enabling an Azure AD user Deprovisioning of an Azure AD user Undo deprovisioning of an Azure AD user Adding an Azure AD user to a group Removing an Azure AD user from a group View the change history and user activity for an Azure AD user Deleting an Azure AD user with the Web Interface Creating a new hybrid Azure user with the Active Roles Web Interface Converting an on-premises user with an Exchange mailbox to a hybrid Azure user Licensing a hybrid Azure user for an Exchange Online mailbox Viewing or modifying the Exchange Online properties of a hybrid Azure user Creating a new Azure AD user with Management Shell Updating the Azure AD user properties with the Management Shell Viewing the Azure AD user properties with the Management Shell Delete an Azure AD user with the Management Shell Assigning Microsoft 365 licenses to new hybrid users Assigning Microsoft 365 licenses to existing hybrid users Modifying or removing Microsoft 365 licenses assigned to hybrid users Updating Microsoft 365 licenses display names
Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Microsoft 365 roles management for hybrid environment users Managing Microsoft 365 contacts Managing Hybrid AD groups Managing Microsoft 365 Groups Managing cloud-only distribution groups Managing cloud-only dynamic distribution 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 cloud-only shared mailboxes
Modern Authentication Managing the configuration of Active Roles
Connecting to the Administration Service 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 Using regular expressions Administrative Template Communication ports Active Roles and supported Azure environments Integrating Active Roles with other products and services Active Roles Language Pack Active Roles Diagnostic Tools Active Roles Add-on Manager

Sample Office 365 workflow scripts

This section contains Microsoft 365 (M365) workflow script samples for reference.

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

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

  • Az.Accounts

  • Az.Resources

  • Exchange Online Management

  • Microsoft.Graph

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 a Microsoft 365 automation workflow.

Example: Importing all supported Azure and M365 Windows PowerShell modules

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

function Microsoft365ScriptTest() {

    $context.O365ImportModules(@("Az.Accounts", "Az.Resources", "ExchangeOnlineManagement", "Microsoft.Graph"))

    $context.O365ExecuteScriptCmd("Get-Module | Select-Object -Property ModuleType,Version,Name | Out-File -FilePath C:\WS\Files\ImportedModulesInnerRunspace.txt")

    Get-AzContext | ConvertTo-Json | Out-File -FilePath C:\WS\Files\Az.txt

    Get-EXOMailbox -Identity user | ConvertTo-Json | Out-File -FilePath C:\WS\Files\ExchangeOnlineManagement.txt

    Get-MgUser -UserId "e38349d9-978a-4e4c-809b-189b68fe713a" | ConvertTo-Json | Out-File -FilePath C:\WS\Files\Microsoft.Graph.txt

    Get-Module | Select-Object -Property ModuleType,Version,Name | Out-File -FilePath C:\WS\Files\ImportedModulesOuterRunspace.txt

}
$context.O365ImportModule (module)

The O365ImportModule function lets you load a single M365 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 Az PowerShell module

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

function TestImportTeamsModule() {
   $context.O365ImportModule("AzureAz", 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 Azure Az module, and then remove the Azure Az module from the PowerShell pool.

#Get a list of disabled users and Directory Roles available
        $_usersinroles= @()
        $_default_log = "C:\temp\Roles.csv"
        $context.O365ImportModule("Microsoft.Graph", 1)
        $context.O365ExecuteScriptCmd("Get-MgUser -filter 'accountEnabled eq false'" +" | Export-Csv " +"c:\temp\DisabledUsers.csv" +" -NoTypeInformation")
        $context.O365ExecuteScriptCmd("Get-MgDirectoryRole | 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.

Enabling Azure Roles

To enable an existing directory role in Azure AD, use the Enabling Azure Roles built-in workflow. This workflow uses two other built-in resources:

  • The O365 script execution configuration activity.

  • The Enabling Azure Roles script.

By default, the Enabling Azure Roles workflow is disabled, as One Identity recommends using it as a template for custom workflows that would use the required values in the script, such as the directory role display name.

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

Activity extensions

In Active Roles, administrators can configure workflow activities of the predefined types that are installed with Active Roles. By default, the list of activities in the Workflow Designer contains only the predefined activity types, such as Approval Activity or Notification Activity. It is possible to extend the list by adding new types of activity.

Each activity type determines a certain workflow action (for example, originating an approval task or notification) together with a collection of activity parameters to configure the workflow action (for example, parameters that specify the approvers or notification recipients). Active Roles builds upon this concept, providing the ability to implement and deploy custom types of workflow activity. It enables custom activity types to be created as necessary, and listed in the Workflow Designer along with the pre-defined activity types, allowing administrators to configure workflow activities that perform custom actions determined by those new types of workflow activity.

Active Roles allows the creation of custom activities based on the Script Activity built-in activity type. However, creating and configuring a script activity from scratch can be time-consuming. Custom activity types provide a way to mitigate this overhead. Once a custom activity type is deployed that points to a particular script, administrators can easily configure and apply workflow activities of that type, having those activities perform the actions determined by the script. The activity script also defines the activity parameters specific to the activity type.

Custom activity types provide an extensible mechanism for deploying custom workflow activities. This capability is implemented by using the Policy Type object class. Policy Type objects can be created by using the Active Roles Console, with each object representing a certain type of custom workflow activity.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating