Upraviť

Zdieľať cez

Configure Playvox for automatic user provisioning

  • Článok

This article describes the steps to follow in both Playvox and Microsoft Entra ID to configure automatic user provisioning. When configured, Microsoft Entra ID automatically provisions and de-provisions users or groups to Playvox by using the Microsoft Entra provisioning service. For important details on what this service does and how it works, and for frequently asked questions, see Automate user provisioning and deprovisioning to SaaS applications with Microsoft Entra ID.

Capabilities supported

  • Create users in Playvox.
  • Remove users in Playvox when they don't need access anymore.
  • Keep user attributes synchronized between Microsoft Entra ID and Playvox.

Prerequisites

The scenario in this article assumes that you already have the following prerequisites:

Step 1: Plan your provisioning deployment

  1. Learn how the provisioning service works.

  2. Determine who will be in scope for provisioning.

  3. Determine what data to map between Microsoft Entra ID and Playvox.

Step 2: Configure Playvox to support provisioning by using Microsoft Entra ID

  1. Log in to the Playvox admin console and go to Settings > API Keys.

  2. Select Create API Key.

    Partial screenshot showing the location of the Create API Key button in the Playvox user interface.

  3. Enter a meaningful name for the API key, and then select Save. After the API key is generated, select Close.

  4. On the API key that you created, select the Details icon.

    Partial screenshot showing the location of the Details icon, which is a magnifying glass, in the Playvox user interface.

  5. Copy and save the BASE64 KEY value. Later, in the Azure portal, you'll enter this value in the Secret Token text box in the Provisioning tab of your Playvox application.

    Screenshot of the Details API Key message box, with the BASE64 KEY value highlighted.

To start to manage provisioning to Playvox, add Playvox to your Microsoft Entra tenant from the application gallery. To learn more, see Quickstart: Add an application to your Microsoft Entra tenant.

If you've previously set up Playvox for single sign-on (SSO), you can use the same application. However, we recommend that you create a separate app when testing the integration initially.

Step 4: Define who is in scope for provisioning

The Microsoft Entra provisioning service allows you to scope who is provisioned based on assignment to the application, or based on attributes of the user or group. If you choose to scope who is provisioned to your app based on assignment, you can use the steps to assign users and groups to the application. If you choose to scope who is provisioned based solely on attributes of the user or group, you can use a scoping filter.

  • Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an attribute based scoping filter.

  • If you need extra roles, you can update the application manifest to add new roles.

Step 5: Configure automatic user provisioning to Playvox

This section guides you through the steps to configure the Microsoft Entra provisioning service to create, update, and disable users or groups, based on user or group assignments in Microsoft Entra ID.

To configure automatic user provisioning for Playvox in Microsoft Entra ID:

  1. Sign in to the Microsoft Entra admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > Enterprise applications.

    Partial screenshot of the Azure portal, with Enterprise applications and All applications items highlighted

  3. In the applications list, search for and select Playvox.

    Partial screenshot of the applications list, with the application search box highlighted.

  4. Select the Provisioning tab.

    Partial screenshot showing the Provisioning menu item.

  5. Set the Provisioning Mode to Automatic.

    Partial screenshot of the Provisioning tab, showing the Automatic option selected in the Provisioning Mode drop-down list box.

  6. In the Admin Credentials section, enter your Playvox Tenant URL as:

    https://{tenant}.playvox.com/scim/v1

    Enter the Secret Token that you copied earlier in Step 2. Then, select Test Connection to ensure that Microsoft Entra ID can connect to Playvox. If the connection fails, make sure your Playvox account has Admin permissions and try again.

    Partial screenshot showing the Admin Credentials section, including Tenant URL and Secret Token text boxes, and with the Test Connection link highlighted.

  7. In the Notification Email text box, enter the email address of a person or group who will receive the provisioning error notifications. Then, select the Send an email notification when a failure occurs check box.

    Partial screenshot showing the Notification Email text box and the email notification check box.

  8. Select Save.

  9. In the Mappings section, select Synchronize Microsoft Entra users to Playvox.

  10. Review the user attributes that are synchronized from Microsoft Entra ID to Playvox in the Attribute-Mapping section. The attributes selected as Matching properties are used to match the user accounts in Playvox for update operations. If you choose to change the matching target attribute, make sure that the Playvox API supports filtering users based on that attribute. Select Save to commit any changes.

    Attribute Type Supported for filtering
    userName String ✓
    active Boolean
    displayName String
    emails[type eq "work"].value String
    name.givenName String
    name.familyName String
    name.formatted String
    externalId String

  11. To configure scoping filters, see the instructions in the Scoping filter article.

  12. To enable the Microsoft Entra provisioning service for Playvox, change the Provisioning Status to On in the Settings section.

    Partial screenshot of Settings section, showing the Provisioning Status set to On.

  13. Still in Settings, define the users or groups to provision to Playvox by choosing the values you want in Scope.

    Partial screenshot of the Settings section, showing the Scope drop-down list box.

  14. When you're ready to provision, select Save.

    Partial screenshot showing Save and Discard options.

This operation starts the initial synchronization cycle of all users and groups defined in Scope in the Settings section. The initial cycle takes longer than later cycles. Later cycles occur approximately every 40 minutes, provided that the Microsoft Entra provisioning service is running.

Step 6: Monitor your deployment

Once you configure provisioning, use the following resources to monitor your deployment:

  1. Use the provisioning logs to determine which users are provisioned successfully or unsuccessfully
  2. Check the progress bar to see the status of the provisioning cycle and how close it's to completion
  3. If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states the application provisioning quarantine status article.

Additional resources

Related content