Set up Azure AD Wizard App in Control Hub

Enable Azure AD in Control Hub

You can't currently use Azure AD Wizard App with Webex for Government. We’ll add support for Webex for Government in the future.

Some of the features described in this article aren’t yet available to all customers. They will be available soon.

Go to Organization Settings and then scroll down to the Directory Synchronization section.

Click Set up to start the configuration.

Authenticate the Azure AD admin account with the Azure AD configuration. Ensure that you use an account that has the permissions described in the next step.

Review the permissions and click Accept to grant the account authorization to access your Azure AD tenant.

Cisco Webex Identity is an Azure AD enterprise application in Azure AD. The Wizard App connects to this application to access Azure AD graph APIs. The permissions required to access it are the minimum permissions needed to support and use it.

Image showing the available permissions.

Permission	Usage
Manage apps that this app creates or owns	Required to manage the Cisco Webex Identity app in Azure AD Enterprise, including: Create/delete this app in Azure AD Attribute mapping configuration Renaming the app in Azure AD Enable/disable auto provision
Read all audit log data	Used to access the Cisco Webex Identity provision audit log to read provisioning history. This information is used for the sync summary and sync report function in the Wizard App.
Read all groups/Read all group memberships	Reads the list of groups from Azure AD to allow successful configuration of the groups sync scope.
Read all users’ full profiles	Used when adding users in the sync scope. For example, this permission allows the reading of user information by searching for a user and displaying the users in the table on the user page.

For SMB customers, accept the default settings by checking the Sync defaults check box and clicking Proceed. For enterprise customers, go to the next step and continue the configuration.

If you accept the default settings, it means that you want to:

Synchronize all users to Webex.
Accept the default attribute mappings.
Enable the toggle to synchronize all users' profile pictures to display on Webex Services.
Enable auto-sync after the configuration completes.

Image showing the Azure AD sync default setting option

For Enterprise customers (more than 1000 users), or the customers who want to configure the settings manually, click the Attributes tab, and map the attributes. Click Save.

You can map other user attributes from Azure to Webex, or change existing user attribute mappings using the Attributes page. You can customize the mapping by ensuring that you configure it correctly. The value that you map as the username is important. Webex uses the user's email address as their username. By default, the userPrincipalName (UPN) in Azure AD maps to the email address (username) in Control Hub.

You can’t edit the mapping during the first setup. At that point, the corresponding instance isn’t built completely and there’s no instance of the customized mapping attribute. However, you can click Edit to change it when the setup completes.

Add users to the synchronization scope by clicking the Users tab.

You can input the username to search and add the user in the synchronization scope. You can also remove a user from the sync scope by clicking the right side Recycle Bin icon. Click Save.

If you want to select all users from Azure AD, select Select all users. If you select it, you don't need to select groups in the scope as this option synchronizes the groups at the same time.

We don’t recommend using Select all users for significant enterprise customers with hundreds of thousands of users, as the initialization process requires a long time. If you accidentally synchronize a lot of users in Control Hub, it also takes longer to delete these users.

Click Save.

On the Groups tab, you can search for individual groups and add them to Webex.

Click on the Sync group members tab to select all users with in the selected groups.
Click on the Sync children groups tab to select users in specific child groups.

Image showing the screen to add or remove groups

Click Save.

By default, only the users in the selected groups will synchronize. Go to the More tab and select Sync group objects if you also want to synchronize the groups themselves.

On the More tab, you can configure some advanced synchronization options:

Sync user avatars—turn this on to allow Webex App to sync all in-scope user's avatars to Webex. When a users avatar is updated, the user’s avatar is automatically updated in Webex. It may not update immediately because it relies on the update notification to trigger the update.
Sync group objects—turn this on so that the selected group objects on the Groups tab are synchronized to Webex.

Activate single sign-on—turn this on to configure OpenID Connect (OIDC) SSO for your organization.

If your organization already has SSO enabled using one of the SAML options, you must disable the SAML option first before you can activate OIDC SSO in the Azure AD Wizard App.

Identify and sync room objects—turn this on to sync room objects to Webex.

You can decide if you want to allow synchronization to take place immediately or at a later stage. If you select the Allow now option, it applies all settings to the upcoming synchronization. If you select the Save and allow later option, synchronization doesn’t start until you allow auto-sync.

Image showing the option to save the configuration

The application communicates with Azure AD to set up the configuration and schedules the synchronization.

Image showing that the setup is successful

After the synchronization completes, one of the following results appears in the Job status field:

Active: the synchronization was successful.
Quarantine: the synchronization job was quarantined in Azure AD after multiple failures. See the Azure AD documentation for more information.
NotRun: this status appears only after first setup. The service has not yet run after first setup.

You can also click View summary to see additional information such as the time and date of the last synchronization, and the number of users synced, skipped, or failed:

Users

Synced: shows the number of users successfully synced to Webex.
Skipped: shows the number of users that were skipped in the last synchronization. For example, new users in Azure AD that were not added to the Azure AD Wizard App sync scope. These users were not synced to Webex; add them in the sync scope to sync them to Webex.
Failed: shows the number of users that failed to sync. Check the Azure AD application provision audit log for more information about why these users failed to sync. If you need to sync these users immediately, you can provision users on demand.

Groups

Synced: shows the number of groups successfully synced to Webex and created in Control Hub.
To Be Synced: this status indicates that all of the users in a group have not yet been added. The users must first be successfully synced to Webex.

Migrate existing Cisco Webex Enterprise App configurations to Azure AD Wizard App

If you already have set up a Cisco Webex Enterprise App in Azure AD, you can migrate all of your configurations over to the Azure AD Wizard App automatically. You can manage Azure AD all in Control Hub without losing any of your previous configurations.

Go to Organization Settings and then scroll down to the Directory Synchronization section.

Click Set up to start the configuration.

Authenticate the Azure AD admin account with the Azure AD configuration. Ensure that you use an account that has the permissions described in the next step.

Review the permissions and click Accept to grant the account authorization to access your Azure AD tenant.

Cisco Webex Identity Synchronization is an Azure AD enterprise application in Azure AD. The Wizard App connects to this application to access Azure AD graph APIs. The permissions required to access it are the minimum permissions needed to support and use it.

Permission	Usage
Manage apps that this app creates or owns	Required to manage the Cisco Webex Identity app in Azure AD Enterprise, including: Create/delete this app in Azure AD Attribute mapping configuration Renaming the app in Azure AD Enable/disable auto provision
Read all audit log data	Used to access the Cisco Webex Identity provision audit log to read provisioning history. This information is used for the sync summary and sync report function in the Wizard App.
Read all groups/Read all group memberships	Reads the list of groups from Azure AD to allow successful configuration of the groups sync scope.
Read all users’ full profiles	Used when adding users in the sync scope. For example, this permission allows the reading of user information by searching for a user and displaying the users in the table on the user page.

Select Migrate existing app.

After accepting additional read-only permission requests, select the existing app that you want to migrate over to the Wizard App, and then select Proceed.

If the selected existing app doesn't provision users to the same Control Hub, the migration will fail.

After the migration completes, we recommend that you perform a dry run before enabling auto-sync to make sure there aren't any errors.

Perform a dry run

Before enabling auto-sync, we recommend that you perform a dry run first to make sure that there aren't any errors. Once the dry run completes, you can download a dry-run report to see detailed information. The available columns in the report are:

Table 1. Dry-run report column descriptions
Column name	Description
Object Type	Type of object in Azure AD, such as user or group.
Action Type	Type of action that will be performed to the object during a synchronization. Possible action types are: Matched—Object matches in Azure AD and Control Hub. Add—Object will be added to Control Hub. Deactivate—Object is in Control Hub, but the object has been removed in Azure AD or wasn't added to the sync scope. After synchronization, the object will be deactivated.
Azure ID	ID of the object in Azure AD.
Azure Name	Name of the object in Azure AD.
Webex Name	Name of the object in Webex.
Reason	Reason for why an action type will occur during a synchronization.

1	Sign in to Control Hub with a full admin account.
2	Go to Organization Settings and then scroll down to the Directory Synchronization section.
3	Click on the three vertical dots next to the instance you want to sync, and then select Dry-run.
4	Once the dry run completes, click on Download summary to download the report as a CSV file.

Enable or disable auto-sync

The Azure AD Wizard and its corresponding backend service checks if auto-sync is enabled, to determine when to sync users or groups from Azure AD to Webex. Enable Auto Sync to allow the auto provision user and group synchronization. When you disable Auto Sync the Wizard App doesn't sync anything to Webex, but the existing configuration is preserved.

1	Log in to Control Hub as the full org admin.
2	Go to Organization Settings and then scroll down to the Directory Synchronization section.
3	Switch the toggle to the right to enable Auto Sync. Disable it by switching the Auto Sync toggle to the left.

Edit Azure AD Wizard App configuration

Go to Organization Settings and then scroll down to the Directory Synchronization section.

Click Edit configuration.

Image showing the option to delete an Azure AD instance

Customize the attribute mapping by selecting an attribute from the left column that originates from Azure AD. The destination attribute in Webex Cloud is in the right column. See Azure AD Wizard App attributes mapping for more information about mapping attributes.

On the Users and Groups tabs, add or remove users and groups from the synchronization scope.

Nested groups don't automatically synchronize to the cloud. Make sure to select any groups that are nested within the groups you want to synchronize.

On the More tab change your preferences if required.

Click Save to save the modified configuration.

Your updates are applied in the next synchronization. The Azure AD automatic sync mechanism handles the synchronization of users and user's groups.

Edit the Webex instance name

Change how the Cisco Webex Identity instance name appears in the Azure AD enterprise application list.

1	Log in to Control Hub as the full org admin.
2	Go to Organization Settings and then scroll down to the Directory Synchronization section.
3	Click Edit instance name.
4	Enter the new instance name and then click Save.

Delete Azure AD Wizard App configuration

When you delete the Azure AD Wizard App, it removes the configuration for Azure AD synchronization. The configuration is not retained by Webex or Azure AD. If you want to use Azure AD synchronization in the future, you'll need to do a full reconfiguration.

Before you begin

1	Log in to Control Hub as the full org admin.
2	Go to Organization Settings and then scroll down to the Directory Synchronization section.
3	Click Delete instance.
4	In the Delete Azure AD Instance? page, select Revoke Azure AD admin consent if you want to remove the consent agreement from Webex. If you select this option, you must enter your credentials and grant the permissions again.
5	Click Delete.

Provision a user to Webex on-demand

You can provision a user to Webex immediately, independently of an Azure AD synchronization, and instantly check the result. This helps when troubleshooting problems during setup.

1	Log in to Control Hub as the full org admin.
2	Go to Organization Settings and then scroll down to the Directory Synchronization section.
3	Click Provision a user on demand.
4	Search for and select the user you want to provision, and click Provision.
5	One of following results appear when it completes: Provisioning success: The new user was successfully created in Webex. Provisioning skipped: The provisioning was skipped for some reason, generally because the user already exists. The details appear on the Results summary page. Provisioning failed: The provisioning failed. The details appear on the Results summary page.
6	Click Re-try to provision the same user again, if it skipped or failed.
7	Click Provision another user to return to the provisioning page.
8	Click Done when you are finished.

Import Azure AD verified domains to Control Hub

The customers may have hundreds of domains verified in Azure AD. While they integrate with Control hub, if they want to import the verified domains from Azure AD to Control Hub. This can save many efforts in the maintenance or setup process.

1	Go to the Domain secion in the Organization Settings tab in Control Hub.
2	Click Add with Azure AD.
3	In the Add verified domains page, search and select the domains to add.
4	Click Add. The verfied domains are a part of the verified domain list.

Azure AD Wizard App attributes mapping

The Azure AD Wizard App can support and synchronize any changes you make to your attribute expressions. For example, in Azure AD, you can map the displayName so that it displays both the surname and givenName attributes. These changes appear in the Wizard App.

You can find more information on mapping attribute expressions in Azure AD on the Microsoft help site.

Use the following table for information on specific Azure AD attributes.

Table 2. Azure to Webex Mappings
Azure Active Directory Attribute (source)	Webex User Attribute (target)	Description
userPrincipalName	userName	It’s the unique ID of the user in Webex. It is an email formatted.
displayName	displayName	User's name that displays on the Webex application.
surname	name.familyName
givenName	name.givenName
objectId	externalId	It is the user's UID in Azure ID. Generally, it is a 16-Bytes string. We do not recommend that you change this mapping.
jobTitle	title
usageLocation	addresses[type eq "work"].country	We recommend using Usagelocation mapping to addresses [type eq "work"].country. If you choose another attribute, you should ensure the attribute values are in compliance with the standards. For example, USA should be US. China should be CN, and so on.
city	addresses[type eq "work"].locality
streetAddress	addresses[type eq "work"].streetAddress
state	addresses[type eq "work"].region
postalCode	addresses[type eq "work"].postalCode
telephoneNumber	phoneNumbers[type eq "work"].value
mobile	phoneNumbers[type eq "mobile"].value
facsimileTelephoneNumber	phoneNumbers[type eq "fax"].value
manager	manager	Syncs manager information of users to Webex so that users can always see the correct manager information on a user's contact card. When a user is created, Azure AD checks if the user's manager object is in Webex Identity or not. If no, the user's manager attribute is ignored. If there is a manager attribute, two conditions must be met for the attribute to show on the user's contact card: The manager object is synced to Webex. The member user is active in Webex App. Technically, it can trigger the backend event to query the user's manager attribute periodically. Therefore, when the user's manager information is added or changed, the user's manager attribute could update through the triggered service. These conditions check the update to the user's manager attribute when a user's authentication token is expired.

FAQ

How can I migrate to Azure AD Wizard App from Cisco Directory Connector provision?

During setup, the Wizard App detects whether your organization uses Directory Connector. If it is enabled, a dialog box where you can choose to use Azure AD and block Directory Connector. Click Block to confirm that you want to continue the Azure AD Wizard App configuration.

You can also choose to disable Directory Connector before configuring the Wizard App. After configuration, the Wizard App manages user profiles. However, the Wizard App only manages the users who were added to the synchronization scope; you cannot use the Wizard App to manage users synced by Directory Connector that were not part of the synchronization scope.

Can I configure single sign-on with Microsoft Azure?

You can configure a single sign-on (SSO) integration between a Control Hub customer organization and a deployment that uses Microsoft Azure as an identity provider.

When does the user avatar update in Webex?

The user avatars are synced to Webex when the user is created in Webex Identity. This update relies on the user's avatar being updated in Azure AD. The Wizard App then retrieves the new avatar from Azure AD.