Enable Entra ID in Control Hub

In Webex for Government, the Entra ID (Azure AD) Wizard App connects exclusively to the Entra ID Global Identity, which covers Consumer/Enterprise and GCC Moderate Entra ID (Azure AD) Customers. GCC High Customers must utilize the Control Hub application in the Microsoft Enterprise Gallery to provision users and groups to Webex. A wizard version supporting GCC High will be available in a future Control Hub release.

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

显示 Azure AD 同步设置的图像。

准备工作

Ensure that you have access to an Entra ID account that has the authority to grant tenant-wide admin consent to an application.
1

Sign in to Control Hub with a full administrator account.

2

转至组织设置 ,然后向下滚动至 目录同步 部分。

3

单击 设置 开始配置。

4

Authenticate your Entra ID admin account.

If you are not a global or privilaged-role administrator in Entra ID, you can request access to grant permission to the Entra ID (Azure AD) Wizard App.

If you have full administrator privileges in Entra ID, you can review and grant access to requests by going to Identity > Applications > Enterprise applications. Under Activity, select Admin consent requests and click on Cisco Webex Identity Integration and select Review permissions and accept. This process grants general authentication to the Webex application.

Finally, click on the All (preview) tab, select Cisco Webex Identity Integration and click Review Application. Under Security > Permissions, click on Grant admin consent for Cisco to grant all the necessary permissions to enable Entra ID in Control Hub.

See Microsoft support for more information on this process.

5

Review the permissions and click Accept to grant the account authorization to access your Entra ID tenant.

Cisco Webex Identity is an Entra ID enterprise application in Entra ID. The Wizard App connects to this application to access Entra ID graph APIs. 访问所需的权限是支持和使用它所需的最低权限。

显示可用权限的图像。
权限 使用情况
Manage apps that this app creates or owns

Required to manage the Cisco Webex Identity app in Entra ID Enterprise, including:

  • Create/delete this app in Entra ID

  • Attribute mapping configuration

  • Renaming the app in Entra ID

  • 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 Entra ID to allow successful configuration of the groups sync scope.
Updates to group memberships can take up to 12 hours to synchronize. If a new user hasn't auto-synced when the group synchronization occurs, you will need to wait another 12 hours for the new user to sync to their group.
读取所有用户的完整档案 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.
6

对于 SMB 客户,选中同步缺省值复选框 并单击继续以接受缺省 设置。对于企业客户,请转至下一步,然后继续配置。

如果您接受缺省设置,则意味着您希望:
  • 将所有用户同步到Webex。
  • 接受缺省属性映射。
  • 启用切换开关可同步所有用户的档案照片以显示在 Webex 服务上。
  • 配置完成后启用自动同步。
显示 Azure AD 同步缺省设置选项的图像
7

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. 单击保存

You can map other user attributes from Entra ID to Webex, or change existing user attribute mappings using the Attributes page. 您可以通过确保正确配置来自定义映射。映射为用户名的值非常重要。Webex 使用用户的电子邮件地址作为其用户名。By default, the userPrincipalName (UPN) in Entra ID maps to the email address (username) in Control Hub.

第一次设置期间不能编辑映射。此时,相应的实例构建不完全,并且没有自定义映射属性的实例。但是,您可以在设置 完成后单击编辑对其进行更改。
8

单击用户标签页将用户添加到同步 范围。

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. 单击保存

If you want to select all users from Entra ID, select Select all users. 如果选中该组,则无需选择范围中的组,因为该选项将同时同步组。

图像显示所有用户已同步

对于拥有成 千上万用户的重要企业客户,我们建议您不要为所有用户进行选择,因为初始化过程需要很长时间。如果您不小心在 Control Hub 中同步了许多用户,删除这些用户还会花费更长时间。

单击保存

9

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.
显示要添加或删除组的屏幕的图像

单击保存

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.
10

在“ 更多 ”标签页中,您可以配置一些高级同步选项:

  • Sync user avatars—turn this on to allow Webex App to sync all in-scope user's avatars to Webex. 更新用户头像后,用户的头像将在更新后自动更新Webex。它可能无法立即更新,因为它依赖于更新通知来触发更新。

  • 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 Entra ID (Azure AD) Wizard App.
  • Identify and sync room objects—turn this on to sync room objects to Webex.

11

您可以决定是否允许立即或稍后进行同步。如果选择“现在 允许” 选项,所有设置将应用于即将进行的同步。如果您选择保存 并稍后允许 选项,同步不会开始,直到您允许自动同步。

显示保存配置选项的图像
12

The application communicates with Entra ID to set up the configuration and schedules the synchronization.

显示安装成功的图像
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 Entra ID after multiple failures. See the Entra ID 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 Entra ID that were not added to the Entra ID (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 Entra ID 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.

  • 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 Entra ID (Azure AD) Wizard App

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

1

Sign in to Control Hub with a full administrator account.

2

转至组织设置 ,然后向下滚动至 目录同步 部分。

3

单击 设置 开始配置。

4

Authenticate the Entra ID admin account with the Entra ID configuration. 确保您使用的帐户具有下一步中描述的权限。

5

Review the permissions and click Accept to grant the account authorization to access your Entra ID tenant.

Cisco Webex Identity Synchronization is an Entra ID enterprise application in Entra ID. The Wizard App connects to this application to access Entra ID graph APIs. 访问所需的权限是支持和使用它所需的最低权限。

显示可用权限的图像。
权限 使用情况
Manage apps that this app creates or owns

Required to manage the Cisco Webex Identity app in Entra ID Enterprise, including:

  • Create/delete this app in Entra ID

  • Attribute mapping configuration

  • Renaming the app in Entra ID

  • 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 Entra ID to allow successful configuration of the groups sync scope.
读取所有用户的完整档案 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.
6

Select Migrate existing app.

7

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.

8

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:

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

Sign in to Control Hub with a full administrator account.

2

转至组织设置 ,然后向下滚动至 目录同步 部分。

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.

启用或禁用自动同步

The Entra ID (Azure AD) Wizard App and its corresponding backend service checks if auto-sync is enabled to determine when to sync users or groups from Entra ID to Webex. Enable Auto Syncto 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.

Typically, users are synced every 40 minutes per Microsoft policy.

1

以完全权限组织管理员登录 Control Hub。

2

转至组织设置 ,然后向下滚动至 目录同步 部分。

3

将切换开关切换到右侧以启用自动 同步

通过切换左侧的自动 同步 开关来禁用它。

Edit the Entra ID (Azure AD) Wizard App configuration

1

Sign in to Control Hub with a full administrator account.

2

转至组织设置 ,然后向下滚动至 目录同步 部分。

3

Click Edit configuration.

显示删除 Azure AD 实例选项的图像
4

Customize the attribute mapping by selecting an attribute from the left column that originates from Entra ID. “Webex 云”中的目标属性位于右列。See Entra ID (Azure AD) Wizard App attributes mapping for more information about mapping attributes.

显示自定义属性的图像
5

在用户 组标签 页中,从同步范围中添加或删除用户和组。

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.
6

如果需要, 更多标签页中更改首选项。

7

单击 Save (保存)保存修改后的配置。

您的更新将应用于下一次同步。The Entra ID 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 Entra ID enterprise application list.

1

Sign in to Control Hub with a full administrator account.

2

转至组织设置 ,然后向下滚动至 目录同步 部分。

3

Click Edit instance name.

显示删除 Azure AD 实例选项的图像
4

Enter the new instance name and then click Save.

Delete the Entra ID (Azure AD) Wizard App configuration

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

Don't delete the Cisco Webex application from within Entra ID.

1

Sign in to Control Hub with a full administrator account.

2

转至组织设置 ,然后向下滚动至 目录同步 部分。

3

Click Delete instance.

显示删除 Azure AD 实例选项的图像
4

如果要从 “删除 Azure AD 实例”中删除同意协议,请选择撤销 Azure AD 管理员Webex。如果选择该选项,必须输入凭证并再次授予权限。

显示删除窗口以删除 Azure AD 实例的图像
5

单击删除

Provision a user to Webex on-demand

You can provision a user to Webex immediately, independently of an Entra ID synchronization, and instantly check the result. 这有助于对设置期间的问题进行疑难解答。

1

Sign in to Control Hub with a full administrator account.

2

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

3

Click Provision a user on demand.

显示删除 Azure AD 实例选项的图像
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 Entra ID verified domains to Control Hub

The customers may have hundreds of domains verified in Entra ID. While they integrate with Control hub, if they want to import the verified domains from Entra ID to Control Hub. 这样可节省维护或设置过程的许多工作。

1

转至 Control Hub 中的“组织设置 ”标签页中的 域安全。

2

Click Add with Entra ID.

3

在添加 已验证域 页面中,搜索并选择要添加的域。

4

单击添加

The verfied domains will appear in the verified domain list.

Entra ID (Azure AD) Wizard App attributes mapping

The Entra ID (Azure AD) Wizard App can support and synchronize any changes you make to your attribute expressions. For example, in Entra ID, 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 Entra ID on the Microsoft help site.

Use the following table for information on specific Entra ID attributes.

Entra ID doesn't synchronize null values. If you set an attribute value to null in Entra ID, it isn't deleted or patched with a null value in Webex. See the limitations on the Microsoft help site for more information.

表 2. Azure 到 Webex 的映射

Entra ID Attribute (source)

Webex 用户属性(目标)

描述

userPrincipalName

userName

It’s the unique ID of the user in Webex. 格式为电子邮件。

displayName

displayName

显示在应用程序上的Webex。

surname

name.familyName

givenName

name.givenName

objectId

externalId

It is the user's UID in Entra ID. 一般情况下,该字符串为 16 字节。我们建议您不要更改此映射。

jobTitle

title

usageLocation

addresses[type eq "work"].country

我们建议使用“使用分配”映射来地址 [type eq “work”].country。如果您选择其他属性,应确保属性值与标准一致。例如,美国应该是美国。中国应为 CN,以此类比。

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, Entra ID 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.

Manager attribute changes won't be reflected on the user's contact card until after the user signs in for the first time after the change.

常见问题解答

How can I migrate to Entra ID (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 Entra ID and block Directory Connector. Click Block to confirm that you want to continue the Entra ID (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 Entra?

You can configure a single sign-on (SSO) integration between a Control Hub customer organization and a deployment that uses Microsoft Entra ID 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 Entra ID. The Wizard App then retrieves the new avatar from Entra ID.