Syncing Dialpad Phone Numbers to Okta

Dialpad supports automatic User-Provisioning lifecycle management via Okta using a SCIM integration. First, you will need to set up SCIM between Dialpad and Okta. 

For more information on that process, have a look at this help center article.  

Who can use this
Dialpad's Okta integration is available to Enterprise users on all Dialpad plans. 
To sync numbers, you must have an Okta administrator account capable of updating the default Okta User profile and the Dialpad User profile.  

Configuration Process

It's as easy as 1-2-3! 

There are three actions to be performed in Okta for any attribute to have sync back to Okta from Dialpad.

  1. Navigate to the Okta Profile Editor (under the Directory section) and add a new attribute to the Okta default User Profile.
  2. Add a new attribute to the Dialpad application User Profile (handling SCIM).
  3. Update the Dialpad application User Profile Attribute Mappings to combine/map the two new attributes added in steps 1 and 2.

Let's have a look at the steps to update Okta with the assigned phone number for the user:

  1. Log in to your Okta domain as an admin and navigate to the Profile Editor page (under the Directory section).


    okta_user.png
  2. Click on the User (default) profile on the resulting page as shown above.
  3. Navigate to the Attributes section and select Add Attribute.


    Okta_profile.png
  4. In the Add Attribute dialog box, enter the following information and click Save:


    Screen_Shot_2022-04-26_at_2.37.03_PM.png
  5. Click on the Profile Editor again and select the Dialpad application profilebeing used to manage SSO and SCIM.


    Screen_Shot_2022-04-26_at_2.39.44_PM.png

    Note
    The actual name of the profile will differ from what is shown below.


  6. Still within the Attributes section, select Add Attribute.


    Screen_Shot_2022-04-26_at_2.41.17_PM.png
  7. In the Add Attribute dialog box, provide the following information, exactly as written, and leave the other fields as they are. Click on Save:

    Attribute Name

    Value

    Data Type

    string

    Display Name

    Dialpad Phone

    Variable Name

    dialpadPhone

    External Name

    phoneNumbers.^[type=='Dialpad'].value

    External Namespace

    urn:ietf:params:scim:schemas:core:2.0:User

    Description

    Dialpad Phone

    Screen_Shot_2022-04-26_at_2.45.45_PM.png
  8. Return to the Dialpad Application Profile and click on the Mappings button.


    Screen_Shot_2022-04-26_at_2.47.34_PM.png
  9. Verify that the Dialpad Application to Okta User direction is chosen and scroll down the mappings section:Screen_Shot_2022-04-26_at_2.49.04_PM.png
  10. Search for the newly created attribute (dialpadPhone) on the right side (Okta Profile). Select the newly added attribute from the drop-down menu and click Save Mappings.Screen_Shot_2022-04-26_at_2.51.00_PM.png
  11. From here, you can either choose to Apply Updates Now (this will update existing users’ profiles [for those who have been assigned the Dialpad application] with the new attribute information) or Don’t Apply Updates (this will apply to new users getting assigned). 
  12. When new users are assigned to the Dialpad application, their Dialpad Phone Numbers attribute in Okta are updated automatically. To verify this, navigate to Directory > People in Okta. Click on the new user and under the Assigned Applications section, click on the Edit button against the Dialpad application. The attribute value should be seen as shown below:
    Screen_Shot_2022-04-26_at_2.53.05_PM.png

Pushing numbers to Okta 

Okta provides the “Profile Sourcing” feature for an application to act as a source of truth for user-profile attributes. 

Tip
Dialpad does not aim to be an actual profile source like Active Directory. This feature in Okta should NOT be enabled if Dialpad is the only application listed under Profile Sources in Okta. Do not use Dialpad as the sole profile source. This feature is best leveraged when there are other profile sources in your org. The priority of Dialpad should also be as low as possible (as down in the list as possible) in the Profile Sources list. 

Let's dive into the configurations needed to be able to push the phone number attribute value to the default Okta profile.

  1. Navigate to Applications in Okta and click on the Dialpad app.
    Screen_Shot_2022-04-26_at_3.20.40_PM.png
  2. Under the Provisioning tab, nested within the Settings section To Okta, click Edit against Profile & Lifecycle Sourcing.
    Screen_Shot_2022-04-26_at_3.23.09_PM.png
  3. Check the checkbox Allow Dialpad to source Okta users and select OK on the pop-up screen.
    Screen_Shot_2022-04-26_at_3.24.25_PM.png
  4. Navigate back to the Profile & Lifecycle Sourcing page, for the option When a user is deactivated in the app. Select the action as Do Nothing. The other options are to be left as-is. Click Save.
    Screen_Shot_2022-04-26_at_3.27.51_PM.png
  5. Under Profile Editor, search for the Dialpad User profile and select Mappings. Ensure Apply mappings on user Create and Update is selected.
    Screen_Shot_2022-04-26_at_3.26.43_PM.png
  6. Return to the Profile Editor and select the Okta User (default) profile.
    Screen_Shot_2022-04-26_at_3.25.23_PM.png
  7. In the Attributes section, click on edit against the Dialpad Phone attribute.
    Screen_Shot_2022-04-26_at_3.28.57_PM.png
  8. And finally, on the resulting screen, select Override Profile Source option from the Source Priority attribute, and choose Dialpad from the resulting drop-down. Click on Save Attribute.


    Screen_Shot_2022-04-26_at_3.30.27_PM.png

And voila! From now on, whenever a user is assigned to the Dialpad application, the associated phone number will be sourced from Dialpad and the user’s Okta profile will be updated with the value. Other applications can fetch this value by having another attribute mapping from Okta to the application.