Onboard Groups
- Phillip Hanegan
The "Onboard Group" workflow provided by EmpowerID offers a structured and intuitive approach for integrating groups into your organization's system. This workflow is tailored to assist users in performing group-related tasks efficiently during onboarding. Key functionalities of this workflow include:
Adding Permanent Members: This feature allows for the seamless addition of permanent group members, ensuring that the right individuals can access necessary organizational resources.
Applying RBAC Membership Policies: Users can add members to a group based on RBAC assignments, such as specific Management Roles, Business Roles, Locations, or group affiliations. If users lose their RBAC assignments, they are automatically removed from the group.
Assigning Responsibility Parties and Owners: Users can designate responsible parties and owners for the group.
Configuring IAM Shop Settings: The group can be published to the IAM Shop, where eligibility and Access Request policies are configured.
Procedure
Step 1: Configure workflow parameters
The Onboard Group workflow incorporates numerous customizable parameters, allowing you to modify the fields displayed to users running the workflow. These parameters are listed in the below table. Customizing these parameters allows you to tailor the workflow to best suit your organization's needs and preferences.
Parameter | Description |
|---|---|
DefaultDomainSuffix | Specifies the default domain suffix that appears in the workflow, such as “empoweridcontractors.onmicrosoft.com” |
DefaultEmailMessageName | Name of email template to use for notifying people on creation of a new group |
DefaultGroupUsageTypeId | Default integer value of the Group Usage Type. |
DefaultValuePermanentMembersOption | This is a Boolean value that specifies whether the Permanent Membership Option radio button appears to users running the workflow.  |
DefaultValueRBACMembershipOption | This is a Boolean value that specifies whether the RBAC Membership Policies radio button appears to users running the workflow.  |
DeputyResourceTypeRoleName | Specifies the Access Level granted to group deputies. The default value is “Resource Role Assigner.” |
GroupAccessLevelNameForRBACMembershipPolicies | Specifies the Access Level for RBAC Membership Policies. The default value is “Group Member.” |
GroupPurposeTextOne_RestrictedCharacters | Specifies the characters that will get removed from GroupPurposeTextOne before the group creation. No delimiters required. Sample values _#$ |
GroupPurposeTextTwo_RestrictedCharacters | Specifies the characters that will get removed from GroupPurposeTextTwo before the group creation. No delimiters required. Sample values _#$ |
ManagementRoleIDsToNotify | This is a comma separated list of Management Role IDs to be notified via email upon creation of a new group. |
OwnerResourceTypeRoleName | Specifies the Access Level granted to group owners. The default value is “Resource Role Assigner.” |
ShowGroupPurposeTextTwo | This is a Boolean value that specifies whether the “Group Purpopse Additional Text” field appears to users running the workflow. |
ShowGroupUsageType | This is a Boolean value that specifies whether the “Group Usage Type” dropdown appears to users running the workflow. |
ShowIAMShopSettings | This is a Boolean value that specifies whether the “Configure IAM Shop Settings” section appears to users running the workflow. |
ShowIAMShopSettings_EligibleAssignees | This is a Boolean value that specifies whether the “Eligible Assignees” option appears to users running the workflow.
|
ShowIAMShopSettings_PreApprovedAssignees | This is a Boolean value that specifies whether the “PreApproved Assignees” option appears to users running the workflow. |
ShowIAMShopSettings_SuggestedAssignees | This is a Boolean value that specifies whether the “Suggested Assignees” option appears to users running the workflow. |
ShowMembershipOptions | This is a Boolean value that specifies whether the “Membership Options” section appears to users running the workflow. |
ShowOwnershipOptions_Deputies | This is a Boolean value that specifies whether the “Deputies” dropdown under the “Group Ownership Settings” section appears to users running the workflow. |
ShowOwnershipOptions_Owners | This is a Boolean value that specifies whether the “Owners” dropdown under the “Group Ownership Settings” section appears to users running the workflow. |
TeamCreationDelayInMinutes | Specifies the mumber of minutes the system should wait before creating a Teams group/channel. |
TeamDelayServerRestriction | This is a Boolean value the specified whether the creation of the Teams group/channel delayed instance should be picked up on the same server. |
To configure workflow parameters, do the following:
Expand Low Code/No Code Workflow on the navbar and select Low Code Workflows.
Select the Workflow tab and search for Onboard Group.
Click the Display Name for the workflow.
Expand the Request Workflow Parameters accordion on the View One page for the workflow and search for the parameter you want to configure.
Click the Edit button for the parameter.
Enter the new value in the Value field and click Save.
Repeat the above steps to configure other parameters as needed.
Step 2: Run the workflow
To onboard a group, follow these steps:
Log in to the Resource Admin portal for your environment.
Navigate to Group Workflows: In Resource Admin, select Groups and then select the Workflows tab.
Launch the Onboard Group Workflow: Click Onboard Group to start the workflow.
This opens the Onboard Group wizard workflow. Follow the wizard and fill in the fields of each section with the appropriate information for your group. Please note that the sections and fields available may vary depending on the configuration of the workflow parameters.
Select a Tenant or Directory: Choose the tenant or directory location for the new group. For on-premise directories like Active Directory, additionally select the appropriate Organizational Unit (OU).
Submit and Proceed: Click Submit to move to the Group Information section.
Fill in General Group Information: Provide details in the following fields:
Group Purpose Text: Enter a name for the group.
Group Purpose Additional Text: Enter a display name for the group.
Group Usage Type: Indicate the intended usage category for the group.
Group Description: Optionally, give a brief description of the group.
Configure Membership Options:
Decide if you want to add permanent members to the group.
Choose whether to apply RBAC membership policies to the group.
Click Next to proceed to Additional Group Details and enter additional information about the group, including:
Group Type: Select the appropriate type for the group.
Is Mail Enabled: If applicable, enable this feature and specify email settings, such as requiring authenticated senders and setting the email domain. Please note mail settings only appear when onboarding groups in directories that support email usage.
Notes: Add any relevant notes about the group.
Click Next to proceed to Owner Information and enter the following information:
Responsible Party: Search for and select the user responsible for managing and maintaining the group.
Owners: Search for and select one or more users to be group owners.
Deputies: Search for and select one or more users to be group deputies.
Click Next to proceed to IAM Shop Settings and do the following:
Decide if the group should be available for request in the IAM Shop.
If yes, select an Access Request Policy and define the following assignee types:
Eligible Assignees: Choose the type (Person, Group, SetGroup, Management Role, Business Role and Location), then search for and select the specific assignees eligible to request access to the group in the IAM Shop.
Preapproved Assignees: Choose the type (Person, Group, SetGroup, Management Role, Business Role and Location), then search for and select the specific assignees who are pre-approved for the group.
Suggested Assignees: Choose the type (Person, Group, SetGroup, Management Role, Business Role and Location), then search for and select the specific assignees suggested for the group.
Optionally, enter any Additional IAM Shop Settings information.
Click Next to proceed.
If you opted to add group members earlier, search for and select one or more accounts to add as group members and then click Next to proceed.
If you opted to add RBAC Membership policies earlier, do the following:
Select the type of RBAC Membership policy type: Choose the type of RBAC Membership policy to apply. Available types include:
Person
Group
Set Group
Management Role
Management Role Definition
Business Role and Location
Search for and select the Assignee: Based on the selected policy type, search for and select the specific assignee. For example, if you selected "Management Role," search for and choose the appropriate Management Role.
Add Additional Assignees: Repeat the above steps to add additional assignee types as needed.
Preview RBAC Membership Resultant People (Optional): Click Preview RBAC Membership Resultant People to see the number of individuals who will be added to the group based on the policy. Review the resultant count, then click Next to view the detailed list of people.
If you opted to Preview RBAC Membership Resultant People:
Review the resultant count.
Click Next to review the detailed list of people.
Review and Submit:
Review the Summary Information: Ensure all information is correct.
Click Submit: Finalize the group onboarding.
Complete the Wizard:
Review the Operation Execution Summary and click Submit to finalize the process.
Click Submit again to exit the wizard.
Results
After completing these steps, the group will be onboarded successfully. You can view the group in the connected system and EmpowerID. To do this:
In Connected System: Navigate to the system and search for the group.
In EmpowerID: Search for the group directly.
Audit Log: Go to System Logs > Audit Log to view the audit log.