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

Adding an Azure AD tenant using Management Shell

To add an Azure AD tenant, use the Active Roles Management Shell. To do so, run the New-QADAzureConfigObject cmdlet on the Management Shell interface.

Description

New-QADAzureConfigObject allows you add an Azure AD tenant to Active Directory.

Usage Recommendations

To add an Azure AD tenant using the tenant ID provided by Microsoft for the default tenant (created at the time of the Microsoft Azure subscription), use New-QADAzureConfigObject.

Syntax
New-QADAzureConfigObject -type 'AzureTenant' -name 'Azuretenantname' -AzureTenantId 'AzureTenantGUID' -AzureTenantDescription 'AzureTenantDescription' -AzureAdminUserID 'AzureGlobalAdminUserID' -AzureAdminPassword 'AzureGlobalIDPassword' -AzureADTenantType 'AzureTenantType'
Parameters

The New-QADAzureConfigObject cmdlet has the following parameters.

  • type (string): Specifies the object class of the directory object to be created (such as User or Group). The cmdlet creates a directory object of the object class specified with this parameter.

    Table 100: Parameter: type (string)

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • name (string): Sets the name attribute to the value of this parameter on the new object created by New-QADAzureConfigObject in the directory.

    Table 101: Parameter: name (string)

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureTenantId (string): Specifies the Azure AD tenant ID obtained from the default tenant (created after subscribing to Microsoft Azure).

    NOTE: The Azure AD ID value configured for this parameter must match the tenant ID configured on the Azure AD side. Otherwise, attempts to create an Azure AD application or manage Azure AD objects will fail.

    Table 102: Parameters: AzureTenantId (string)

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureTenantDescription: Specifies the required description of the Azure AD tenant.

    Table 103: AzureTenantDescription

    Required

    false

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureAdminUserID: Specifies the administrative user name for Microsoft Azure AD.

    NOTE: To perform license management or Azure user, guest user, and group management, the administrative user must have the required privileges (for example, License Administrator, User Administrator or Groups Administrator roles).

    For more information on the available privileges and for an overview of the various Azure and Azure AD administrative roles, see Azure AD built-in roles and Classic subscription administrator roles, Azure roles, and Azure AD roles in the official Microsoft documentation.

    Table 104: Parameters: AzureAdminUserID

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureAdminPassword: Specifies the administrative user password for Microsoft Azure AD.

    Table 105: Parameters: AzureAdminPassword

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureADTenantType: Specifies the Azure AD tenant type (Federated, Non-Federated, or Synchronized Identity).

    NOTE: Make sure that you select the tenant type corresponding to your organization environment.

    Table 106: Parameters: AzureADTenantType

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

    Accepts value

    • Federated

    • NonFederated

    • SynchronizedIdentity

Examples

See the following use cases for examples on how to use this cmdlet.

Creating a new Azure AD tenant with a local user

To create a new Azure AD tenant with a locally logged on user

  1. Connect to any available domain controller with the credentials of your local user.

  2. Create a new Azure AD tenant with the following New-QADAzureConfigObject cmdlet:

    C:\PS> New-QADAzureConfigObject -type 'AzureTenant' -name 'CompanyAzuretenant' -AzureTenantId 'CompanyAzureTenantID' -AzureTenantDescription 'Azure tenant for Company' -AzureAdminUserID 'AzureAdminUser1' -AzureAdminPassword 'AzureAdminPassword1’ -AzureADTenantType 'AzureTenantType'
Creating a new Azure AD tenant with a specific user and then disconnecting

To create a new Azure AD tenant with a specific user and then disconnect

  1. Connect to any available domain controller:

    C:\PS> $pw = read-host "Enter password" -AsSecureString

  2. Connect to the local Administration Service with a specific user of your choice:

    C:\PS> connect-qadService -service 'localhost' -proxy -ConnectionAccount 'company\administrator' -ConnectionPassword $pw

  3. Create the new Azure AD tenant:

    C:\PS> New-QADAzureConfigObject -type 'AzureTenant' -name 'CompanyAzuretenant' -AzureTenantId 'CompanyAzureTenantID' -AzureTenantDescription 'Azure tenant for Company' -AzureAdminUserID 'AzureAdminUser1' -AzureAdminPassword 'AzureAdminPassword1’ -AzureADTenantType 'AzureTenantType'

  4. Once the Azure AD tenant is created, disconnect your user:

    C:\PS> disconnect-qadService

Add an Azure AD application using Management Shell

To add an Azure AD application to the Azure AD tenant, you can use the Active Roles Management Shell.

To add an Azure AD application

On the Management Shell interface, run the New-QADConfigObject cmdlet.

Synopsis

This cmdlet allows you to add an Azure AD application to the Azure AD tenant.

Syntax
New-QADAzureConfigObject -type 'AzureApplication' -name 'AzureApplication' -DisplayName 'ApplicationDisplayName' -AzureTenantId 'AzureTenantGUID' -AzureAppPermissions 'ApplicationPermission'
Description

To add an Azure AD application, use this cmdlet.

Parameters

  • type (string): To specify the object class of the directory object to be created, use this parameter. This is the name of a schema class object, such as User or Group. The cmdlet creates a directory object of the object class specified by the value of this parameter.

    Table 107: Parameters: type (string)

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • name (string): To set the name attribute to this parameter value on the new object created by this cmdlet in the directory, use this parameter.

    Table 108: Parameters: name (string)

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureTenantId (string): To enter the Azure AD tenant ID obtained from the default tenant created after subscribing for Microsoft Azure, use this parameter.

    CAUTION: The values that you enter when you configure the Azure AD tenant must exactly match the values configured for Azure AD. Otherwise, the Azure AD application creation and the management of the Azure AD objects will fail.

    Table 109: Parameters: AzureTenantId (string)

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • Displayname (string): To specify the displayName attribute to this parameter value, use this parameter.

    Table 110: Parameters: Displayname (string)

    Required

    false

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureAppPermissions: To specify the permission scope for applications for Azure AD, use this parameter.

    Table 111: Parameters: AzureAppPermissions

    Required

    true

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

  • AzureApplicationDescription: To specify the description of the Azure AD application, use this parameter.

    Table 112: Parameters: AzureApplicationDescription

    Required

    false

    Position

    named

    Accepts pipeline input

    false

    Accepts wildcard characters

    false

Example 1

Connect to any available domain controller with the credentials of the locally logged on user, and create a new Azure AD application:

C:\PS> New-QADAzureConfigObject -type 'AzureApplication' -name 'AzureApplication' -DisplayName 'ApplicationDisplayName' -AzureTenantId 'AzureTenantGUID' -AzureAppPermissions 'ApplicationPermission'

Example 2

Connect to the local Administration Service with the credentials of a specific user, create a new Azure AD tenant and then disconnect:

C:\PS> $pw = read-host "Enter password" -AsSecureString

C:\PS> connect-qadService -service 'localhost' -proxy -ConnectionAccount 'company\administrator' -ConnectionPassword $pw

C:\PS> New-QADAzureConfigObject -type 'AzureApplication' -name 'AzureApplication' -DisplayName 'ApplicationDisplayName' -AzureTenantId 'AzureTenantGUID' -AzureAppPermissions 'ApplicationPermission'

C:\PS> disconnect-qadService

Active Roles configuration steps to manage Hybrid AD objects

To configure Active Roles to manage Hybrid AD objects

  1. Create an Azure AD tenant.

  2. Create the Azure AD application.

  3. Provide the administrator consent for the Azure AD application.

  4. Enforce the Built-in Policy - Azure - Default Rules to Generate Properties Policy Object to the on-premises Active Directory containers, which are synchronized to Azure AD.

NOTE: Consider the following when configuring Active Roles to manage Hybrid AD objects

  • After an upgrade the edsvaAzureOffice365Enabled is not available for viewing or editing from Organizational Unit > Advanced Properties or through the management shell cmdlet. However, the organizational unit container continues to be an Azure-enabled container because the Azure policy is already applied.

Configuring the Azure - Default Rules to Generate Properties policy

If you want to manage hybrid Azure objects (such as hybrid Azure users) in your Organization Unit (OU), then use the built-in Azure - Default Rules to Generate Properties Policy Object of the Active Roles Console (also known as the MMC Interface) to provision the default properties and accepted values or hybrid objects.

To configure the built-in Azure - Default Rules to Generate Properties policy

  1. In the Active Roles Console, navigate to Configuration > Policies > Administration > BuiltIn.

  2. Right-click on Built-in Policy - Azure - Default Rules to Generate Properties and click Policy Scope.

  3. To open the Select Objects dialog for specifying the OU for provisioning, click Add.

  4. To specify the OU for provisioning hybrid Azure users, click Add, browse the OU you want to provision, and click Add.

    TIP: If no elements are displayed in the Select Objects dialog, select Click here to display objects.

  5. To apply the changes and close the dialog, click OK.

NOTE: The new provisioning policy settings will be applied automatically only to objects created after configuring the Azure - Default Rules to Generate Properties Policy Object.

To create cloud Azure users for existing on-premises users, you must configure the cloud Azure users manually for each existing on-premises user on the Active Roles Web Interface. To do so:

  1. Navigate to the folder of the hybrid users of the OU under Directory Management > Tree > Active Directory > <your-AD-folder> > <your-OU-folder>.

  2. Select the on-premises user for which you want to create a cloud Azure user.

  3. To open the New Azure User dialog, on the right pane, click Create Azure User. For more information on the steps of creating a new cloud Azure user, see Creating a new cloud-only Azure user.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating