Chat now with support
Chat with Support

Active Roles 8.0 LTS - 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 Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users 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 Microsoft 365 Groups Managing Azure Security Groups Managing cloud-only distribution 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
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: Active Roles integration with other One Identity and Quest products Appendix F: Active Roles integration with Duo Appendix G: Active Roles integration with Okta Active Roles Language Pack

Prerequisites of enabling OneDrive in an Azure tenant

Before configuring OneDrive for an Azure tenant in the Active Roles Configuration Center, make sure that the Azure tenant meets the following conditions:

  • The Azure tenant has the Sites.FullControl.All SharePoint application permission. Active Roles automatically configures this permission when consenting Active Roles as an Azure application for a newly-configured Azure tenant.

    However, if the Azure tenant for which you want to enable OneDrive has already been used in an Active Roles version earlier than Active Roles 7.5, you must add the Sites.FullControl.All SharePoint application permission manually for Active Roles in the Azure tenant. Failure of doing so will result in an error in the Tenant Details window of the Active Roles Configuration Center when testing the configured SharePoint credentials.

    For more information, see Checking and adding the Sites.FullControl.All permission for Active Roles.

Checking and adding the Sites.FullControl.All permission for Active Roles

If the Azure tenant for which you want to enable OneDrive has already been used in an Active Roles version earlier than Active Roles 7.5, you must add the Sites.FullControl.All SharePoint application permission manually for Active Roles in the Azure tenant. Failure of doing so will result in an error in the Tenant Details window of the Active Roles Configuration Center when testing the configured SharePoint credentials.

To check that Active Roles has the Sites.FullControl.All application permission in an Azure tenant

  1. Log in to Azure Portal.

  2. Open the Azure tenant of your organization by clicking Azure Active Directory on the main screen.

  3. To open the list of applications registered for your Azure tenant, navigate to Manage > App registrations.

  4. Select your Active Roles deployment either by finding it in the All applications or Owned applications list, or by searching it in the search bar.

  5. To open the list of API permissions, navigate to Manage > API permissions.

  6. Check that the Sites.FullControl.All permission is listed under the API / Permissions name > SharePoint heading.

    Figure 158: List of configured permissions under Azure Active Directory > Manage > API Permissions of Azure Portal

If Sites.FullControl.All is not listed, add it to Active Roles in the Azure tenant by completing the next procedure.

To add the Sites.FullControl.All application permission to Active Roles in an Azure tenant

  1. In the Configured permissions list (available under Manage > API permissions) click Add a permission.

    The list of available API permissions will appear on the right side of the screen under Request API permissions.

  2. In the list of available API permissions, click SharePoint.

  3. Click Application permissions.

  4. Under Select permissions > Sites, select Sites.FullControl.All and click Add permissions.

  5. To apply your changes, select Sites.FullControl.All under Configured permissions and click Grant admin consent for <azure-tenant-name>.

Configuring OneDrive for an Azure tenant

Use the Azure AD Configuration > Modify (Tenant details) window of the Active Roles Configuration Center to enable OneDrive storage for the cloud-only and hybrid users of your selected Azure tenant.

Prerequisites

Before beginning the configuration, make sure that the selected Azure tenant meets the requirements listed in Prerequisites of enabling OneDrive in an Azure tenant.

To enable OneDrive storage for Azure users in an Azure tenant

  1. In the Active Roles Configuration Center, click Azure AD Configuration.

  2. Select the Azure tenant for which you want to enable OneDrive storage, and click Modify. The Tenant details window appears.

    Figure 159: Active Roles Configuration Center > Azure AD Configuration > Modify

  3. To start the configuration of the OneDrive storage, select Enable OneDrive.

  4. To register Active Roles as a SharePoint App-Only for OneDrive authentication, open the SharePoint App-Only configuration site of your Azure tenant in your web browser:

    <azure-tenant-name>.sharepoint.com/_layouts/15/appregnew.aspx

    TIP: To quickly open the SharePoint App-Only configuration site from the Tenant details window, expand the procedure overview above Enable OneDrive to access a clickable link.

  5. On the SharePoint App-Only configuration site, configure the following settings:

    • Client ID: Generate a new client ID.

    • Client Secret: Generate a new client secret.

    • Title: Provide a name for the configuration (for example, Active Roles SharePoint app).

    • App Domain: Specify a custom application domain for the configuration.

      NOTE: Make sure that the specified App Domain is not a reserved domain (such as the domain of your Azure tenant), otherwise the SharePoint App-Only cannot be created. One Identity recommends specifying https://www.localhost.com as App Domain.

    • Redirect URI: Specify a custom redirect URI for the configuration (such as https://localhost).

  6. To apply your changes and create the SharePoint App-Only, click Create. Upon successful configuration, the SharePoint App-Only configuration site displays the configured settings with the following message:

    The app identifier has been successfully created.

  7. Copy the Client ID and Client Secret values to your clipboard or elsewhere, as they will be required for the next step.

  8. Grant the required permissions for the configured SharePoint App-Only. To do so, open the application invitation page of the SharePoint administration site of your Azure tenant in your web browser with a Global Administrator user:

    <azure-tenant-name>-admin.sharepoint.com/_layouts/15/appinv.aspx

    TIP: To quickly open the SharePoint administration site from the Tenant details window, expand the procedure overview above Enable OneDrive to access a clickable link.

  9. On the SharePoint administration site, configure the following settings:

    • App ID: Paste the client ID generated on the SharePoint App-Only configuration site here.

      TIP: To quickly fill the Title, App Domain and Redirect URL fields, click Lookup after pasting the client ID into the App ID field.

    • Title: Provide the name that you specified for the configuration on the SharePoint App-Only configuration site.

    • App Domain: Specify the custom application domain that you specified on the SharePoint App-Only configuration site.

    • Redirect URL: Specify the custom redirect URI that you specified on the SharePoint App-Only configuration site.

    • Permission Request XML: Paste the following XML code into the text box:

      <AppPermissionRequests AllowAppOnlyPolicy="true">
  <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
  <AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="FullControl" />
</AppPermissionRequests>

  10. To apply your changes and grant the application permissions, click Create.

  11. In the Tenant details window of the Active Roles Configuration Center, configure the following settings:

    • SharePoint Application (Client) ID: Paste the client ID generated on the SharePoint App-Only configuration site.

    • SharePoint Client Secret: Paste the client secret generated on the SharePoint App-Only configuration site.

    • OneDrive admin site URL: Specify the URL of the SharePoint administration site of your Azure tenant. The URL has the following syntax: <azure-tenant-name>-admin.sharepoint.com

    • OneDrive storage default size (in GB): Specify the default OneDrive storage size allocated for each Azure user in the Azure tenant. This field accepts only an integer and its value must be within the range of the storage size allowed by the OneDrive subscription in use within your organization.

      NOTE: The OneDrive admin site URL and OneDrive storage default size (in GB) settings of the Tenant details window are applicable to cloud-only Azure users only, and do not affect OneDrive provisioning for hybrid users in your Azure tenant. To configure the OneDrive admin site URL and the default OneDrive storage size for hybrid users, you must set these settings in the Active Roles Console (also known as the MMC Interface) by configuring an O365 and Azure Tenant Selection policy for your Azure tenant, after configuring OneDrive in the Active Roles Configuration Center. For more information, see Configuring an O365 and Azure Tenant Selection policy.

  12. To check the SharePoint authentication configuration, click Test credentials.

    TIP: If the test fails for any reason, Active Roles indicates it with an error message. Typically, testing can fail for the following reasons:

    • The specified client ID and/or client secret is incorrect. To resolve the problem, double-check that they were copied correctly from the SharePoint App-Only configuration site.

    • The required application permissions were not granted in the SharePoint administration site of your Azure tenant. To resolve the problem, open the application invitation page of the SharePoint administration site of your Azure tenant, and copy the permission request XML code indicated in this procedure.

    • The Azure tenant is not consented. To resolve the problem, make sure that the Azure tenant is consented. For more information, see Configuring a new Azure tenant and consenting Active Roles as an Azure application.

    • If the Azure tenant for which you configure OneDrive has already been used in Active Roles versions earlier than 7.5, then the Azure tenant may not have the Sites.FullControl.All SharePoint permission granted. To resolve the problem, verify that the Sites.FullControl.All permission is granted for the Azure tenant. For more information, see Checking and adding the Sites.FullControl.All permission for Active Roles.

    • The specified OneDrive admin URL is incorrect. To resolve the problem, double-check that the specified admin URL is correct and belongs to the Azure tenant for which OneDrive is configured.

    • The specified OneDrive storage default size is incorrect (that is, the field is left empty, does not contain a numeric value, or the specified value is outside the storage size range available by the Microsoft 365 plan of your organization). To resolve the problem, specify a valid storage size.

    • A problem occurred in your internet connection. To resolve the problem, check your internet connection and try again.

  13. Once testing completed successfully, to apply your settings, click Save.

    NOTE: You can save the OneDrive configuration only if the test completes successfully.

  14. (Optional) If you want to provision OneDrive storage for hybrid Azure users as well in your Azure tenant, then set up a new O365 and Azure Tenant Selection policy in the Active Roles Console (also known as the MMC Interface). For more information, see Configuring an O365 and Azure Tenant Selection policy.

NOTE: When creating a new hybrid or cloud-only Azure user in the Active Roles Web Interface after completing this procedure, make sure that you grant them the SharePoint Online license in the Licenses step. Otherwise, the configured OneDrive storage cannot be provisioned for the new Azure user. For more information, see Creating a new cloud-only Azure user.

Removing an Azure AD tenant

You can use the Active Roles Configuration Center to delete an Azure AD tenant. This is typically required when an Azure tenant and its directory objects become obsolete because of organizational reasons.

To remove an Azure AD tenant

  1. In the Active Roles Configuration Center, on the left pane, click Azure AD Configuration.

    The list of existing Azure tenants appears.

  2. On the Azure AD Configuration page, from the list of Azure tenants, select the tenant that you want to remove.

  3. Click Remove.

  4. Authenticate your Azure AD administrator account.

    • If you already used one or more Azure AD administrator accounts on your PC, select your account from the Pick an account list, then provide the account password. If you do not find your account in the list, specify your account by clicking Use another account.

    • If you have not used any Azure AD administrator accounts yet on the PC (for example, because you are configuring a fresh Active Roles installation), specify your account user name in the Sign in field, then provide your password.

    NOTE: Make sure to specify the account used for adding the Azure tenant (that is, the account name listed under the Name column of the Azure tenant). Authenticating with another account will result in an error.

  5. The Azure tenant and all the related domains and applications are then deleted upon successful login.

  6. To apply the changes, you must restart the Administration Service, as indicated on the user interface. To restart the Administration Service, open the Configuration Center, click Administration Service on the left pane, then either click Restart, or first click Stop and then Start.

  7. (Optional) If you want to force the deletion of the Active Roles Azure application on the Azure Portal for the removed Azure tenant, click Remove Azure Application and log in with the credentials of the removed Azure tenant.

    This is typically recommended as an extra housekeeping and security measure if the removed Azure tenant has been previously managed either in earlier Active Roles versions or on other machines as well, but the Azure tenant has not been removed from those Active Roles installations prior to uninstalling them (leaving their client secret intact on the Azure Portal).

    CAUTION: Using the Remove Azure Application option will result in all Active Roles installations losing access to the specified Azure tenant. If this happens, users managing the Azure tenant in another Active Roles installation (for example, on another machine) can regain access to the Azure tenant if they:

    1. Remove the Azure tenant in the Azure AD Configuration tab of their Active Roles Configuration Center.

    2. Add the Azure tenant again, as described in Configuring a new Azure tenant and consenting Active Roles as an Azure application.

  8. To confirm removal, check if the removed Azure tenant has disappeared from the list of Azure tenants in the Azure AD Configuration page of the Active Roles Configuration Center, and from the Directory Management > Tree > Azure node of the Active Roles Web Interface.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating