Chat now with support
Chat with Support

We are currently experiencing a OneLogin Outage within the US region, please consult https://www.onelogin.com/status for further details.

Active Roles 8.1.3 - Administration Guide

Introduction Getting started with Active Roles Configuring rule-based administrative views Configuring role-based administration 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 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
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 Migrating Active Roles configuration with the Configuration Transfer Wizard Managing Skype for Business Server with Active Roles
About Skype for Business Server User Management Active Directory topologies supported by Skype for Business Server User Management User Management policy for Skype for Business Server User Management Master Account Management policy for Skype for Business Server User Management Access Templates for Skype for Business Server Configuring the Skype for Business Server User Management feature Managing Skype for Business Server users
Exchanging provisioning information with Active Roles SPML Provider Monitoring Active Roles with Management Pack for SCOM Configuring Active Roles for AWS Managed Microsoft AD Azure AD, Microsoft 365, and Exchange Online Management
Configuring Active Roles to manage Hybrid AD objects Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Changes to Active Roles policies for cloud-only Azure objects
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 Configuring federated authentication 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

Changing the Active Roles Service account to use a gMSA

Active Roles provides support to change an Active Roles account to use a gMSA.

To change the Administration Service account to use a gMSA as the service account

  1. Start Configuration Center on the computer running the Administration Service.

    You can start Configuration Center by selecting Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system. For more information, see Running Configuration Center.

  2. In the Configuration Center main window, under Administration Service > Service account, click Change.

  3. In the Change Service Account dialog, under Service Account, click Browse.

  4. In the Select User or Service Account dialog, click Object Types.

  5. In the Object Types dialog, select the Service Accounts object type along with the Users object type and click OK.

  6. In the Service User or Service Account dialog, click Check Names to select the required gMSA, and click OK.

    The Change Service Account dialog displays the new login name for the gMSA. The Password field is disabled.

  7. Click Change to save the changes for the service account.

    If the system that is running the Active Roles Service is not linked to the gMSA, then an error is displayed prompting you to check if the system is permitted to use the provided gMSA.

    If the gMSA is not part of the Local Administrators group, then an error is displayed prompting you to check if the gMSA is a member of the Local Administrators group on the system.

    If all the prerequisites are met, the service account is changed to gMSA successfully and the success message is displayed.

Changing the Active Roles Admin account

When you configure the Active Roles Administration Service, you are prompted to specify the group or user account that will have unrestricted access to all Active Roles features and functions. This account is referred to as Active Roles Admin. By default, Active Roles Admin is the Administrators local group on the computer running the Administration Service. You can change this setting in the Configure Administration Service wizard when initially configuring the Administration Service.

After you have configured the Administration Service, you can choose a different Active Roles Admin account by using Active Roles Configuration Center on the computer running the Administration Service.

To change the Active Roles Admin Account

  1. Start Configuration Center on the computer running the Administration Service.

    You can start Configuration Center by selecting Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system. For detailed instructions, see Running Configuration Center.

  2. In the Configuration Center main window, under Administration Service, click Manage Settings.

  3. On the Administration Service page, in the Active Roles Admin area, click Change.

  4. On the Active Roles Admin page in the Change Active Roles Admin wizard that appears, click Browse and select the group or user account you want to be designated as Active Roles Admin.

    If you select a group, any member of that group will have the Active Roles Admin rights. If you select a user account, then only that account will have the Active Roles Admin rights.

  5. Click Change on the Active Roles Admin page.

NOTE: The Active Roles Admin setting is specific to the instance of the Administration Service. If you have multiple Administration Service instances deployed in your environment, then you need to apply the changes on each computer running the Administration Service.

Enabling or disabling diagnostic logs

Active Roles administrators can enable diagnostic logging at the request of support personnel to assist them in finding root causes of issues that occur during Active Roles operations. The diagnostic information includes the Active Roles configuration statistics (referred to as Active Roles system summary), the Active Roles Administration Service diagnostic log and the Active Roles Console diagnostic log.

The Active Roles Administration Service’s diagnostic log (ds.log) contains tracing information, such as API calls, internal function calls and state transitions performed by the Administration Service. This information is stored in the ds.log file that you can send to the support team for issue diagnostic purposes. Two logging levels are available: Basic and Verbose. The Verbose option writes much more information to the log, which can aid in the process of isolating an issue. However, with the increase in verbosity comes a corresponding decrease in performance and increase in the size of the log file.

The Active Roles Console’s diagnostic log (EDMSnap.txt) contains debugging information specific to the Active Roles Console, this can be helpful in isolating Console-related issues.

You can use the Active Roles Console to perform the following tasks:

  • Export Active Roles system summary.

    This option allows you to save the Active Roles configuration statistics to a file that you can later send to the support team for diagnosing the issue.

  • Turn the Administration Service’s diagnostic log on or off.

    The Console shows the path to the log file located on the computer running the Administration Service.

  • Choose the level of verbosity for the Administration Service: Basic or Verbose.

    The Verbose option results in a more detailed log, but considerably increases the size of the log file.

  • Turn the Console’s diagnostic log on or off.

    The Console shows the path to the Console’s log file on the local computer.

It is also possible to enable or disable diagnostic logs by using Configuration Center (see Logging management tasks). The following instructions apply to the Active Roles Console.

To view or change the diagnostic settings

  1. Log on as an Active Roles Admin, and open the Active Roles Console.

  2. In the Active Roles Console tree, click the root node to display the Active Roles summary page in the details pane.

  3. On the summary page, expand the Diagnostics area.

    In the Diagnostics area, you can view whether the Active Roles Administration Service’s diagnostic logging is currently enabled (turned on) or disabled (turned off).

  4. In the Diagnostics area, click View or change diagnostic settings.

    This opens the Diagnostics page in the Properties dialog for the Administration Service instance to which the Console is currently connected. Another way to open that page is by directly opening the Properties dialog from the Administration Service object in the Configuration/Server Configuration/Administration Service container.

  5. Use the Diagnostics page to perform the following tasks:

    • To turn the Administration Service’s log on or off, click the appropriate option. This option enables or disables the Administration Service diagnostic logging on the computer running the Administration Service instance to which the console is currently connected.

    • Choose the level of verbosity from the Logging level list, if you have selected the option to turn on the Administration Service’s log.

    • View the path and name of the Administration Service’s log file, along with the name of the computer that holds the log file.

    • Click the appropriate option to turn on or off the Console’s log. This option enables or disables the console diagnostic logging on the local computer.

    • View the path and name of the Console’s log file, along with the name of the computer that holds the log file.

  6. Click Export Active Roles system summary to save the Active Roles configuration statistics to a file that you can later send to the support team for diagnosing the issue.

  7. When finished, click OK or Apply for your changes to take effect.

Active Roles Log Viewer

The Log Viewer tool enables you to browse and analyze diagnostic log files created by the Active Roles Administration Service as well as event log files created by saving the Active Roles event log in Event Viewer on the computer running the Administration Service. Log Viewer can help you drill down through the sequence or hierarchy of requests processed by the Administration Service, identify error conditions that the Administration Service encountered during request processing, and find Knowledge Articles that apply to a given error condition.

With Log Viewer, you can open an Active Roles diagnostic log file (ds.log) or saved event log file (.evtx), and view a list of:

  • Errors encountered by the Administration Service and recorded in the log file.

  • Requests processed by the Administration Service and traced in the log file.

  • All trace records found in the diagnostic log file.

  • All events found in the event log file.

When you select an error in the list, you can choose a command to look for solution in Knowledge Base. The command performs a search in One Identity Software Knowledge Base to list the Knowledge Articles that can provide helpful information on how to troubleshoot the error you selected.

Log Viewer also enables you to:

  • Search the list for a particular text string, such as an error message.

  • Filter the list by various conditions, to narrow the set of list items to those you are interested in.

  • View detailed information about each list item, such as error details, request details or stack trace.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating