Okta SCIM

Manage Regal Voice users from your Okta organization

This guide describes how to set up the Regal Voice Okta app in order to enable SCIM to create, update or deprovision Regal Voice users directly from your Okta org.

Supported Features

  • Create Users: Create users in the Regal Voice app by assigning it to them through your Okta organization.
  • Update User Attributes: Update users attributes in Regal Voice by changing them in your Okta organization.
  • Deactivate Users: Remove users' Regal Voice access by deprovisioning them from your Okta organization.

Prerequisites

You'll need a Username, and Password to complete setup. Email [email protected] to request these.

Requirements

Configure SCIM for Regal Voice

Step 1: Click the Sign On Tab.

Step 2: Ensure that Application username format is set to Email. If it is not, click Edit, navigate to Credentials Details and select Email from the dropdown before saving.

Set Application Username FormatSet Application Username Format

Set Application Username Format

Step 3: Click the Provisioning tab.

Step 4: Click the Configure API Integration.

Configure AppConfigure App

Configure App

Step 5: Check the Enable API Integration box.

Step 6: A username and password is required to set up the integration. Email [email protected] to get your username and password.

Step 7: Enter the username and password provided and click Test Connection. You will see a success message if the credentials are valid.

Test ConnectionTest Connection

Test Connection

Step 8: After validating the connection, click Save.

Step 9: Click Edit and choose the SCIM features you would like to use. Click Save after all have been chosen.

Selecting SCIM FeaturesSelecting SCIM Features

Selecting SCIM Features

There are 4 required attributes that will be mapped to Regal Voice users created through provisioning:

  • User Name (userName, which will be the email of the user)
  • First Name (firstName)
  • Last Name (lastName)
  • Email (email)

userType is a field that is required when assigning a user or a group to the Regal Voice app. This will not be mapped from your Okta organization. Instead, this will need done at the time of provisioning. The value can be either agent or admin depending on the role of the agent.

Assigning Regal Voice App to Users and Groups

To assign users from your Okta organization to the Regal Voice application:

Step 1: Navigate to Applications > Applications through the Okta sidebar when logged in to the admin dashboard.

Step 2: Click on Regal Voice.

Step 3: Click on the Assign dropdown and choose whether you'd like to assign the application to Users or Groups.

Assigning Users to the Regal Voice AppAssigning Users to the Regal Voice App

Assigning Users to the Regal Voice App

Step 4:

If assigning to Users:

  • Go through the list of Users and click Assign to the ones you'd like to add to the application.
  • After clicking Assign, choose a role for the User.
  • Click Save and Go Back.
  • Click Done once finished to assign the chosen users to the Regal Voice app.

If assigning to Groups:

  • Go through the list of Groups and click Assign to the ones you'd like to add to the application.
  • After clicking Assign, choose a role for the Group.
  • Click Save and Go Back.
  • Click Done once finished to assign the chosen Groups to the Regal Voice app.
Selecting a userType for Provisioned Users.Selecting a userType for Provisioned Users.

Selecting a userType for Provisioned Users.

Once finished, users will be able to log into Regal Voice through their Okta dashboard.

Regal Voice as displayed on the End User DashboardRegal Voice as displayed on the End User Dashboard

Regal Voice as displayed on the End User Dashboard

Deprovisioning Users from Regal Voice

To remove a Okta user's access to Regal Voice:

Step 1: Navigate to Applications > Applications through the Okta sidebar when logged in to the admin dashboard.

Step 2: Click on Regal Voice.

Step 3: Choose either Users or Groups from the left menu.

Current Regal Voice AssignmentsCurrent Regal Voice Assignments

Current Regal Voice Assignments

Step 4: Click the x next to the User or Group you want to remove Regal Voice access from.

Step 5: Click Ok on the unassign confirmation dialog.

Confirm User UnassignmentConfirm User Unassignment

Confirm User Unassignment

The user or group has now been unassigned from Regal Voice. They will no longer see it on their Okta dashboard or be able to log in to Regal Voice.

Known Issues/Troubleshooting

If you have any issues setting up Okta, please email [email protected]


Did this page help you?