Prerequisites
Before setting up Okta, you must sign-up for an Agora account via https://app.getagora.com/signup
Supported Features
Create Users. Users in Okta that are assigned to the Agora application are automatically added as members without any permissions to your organization in Agora.
Update User Attributes. Attributes like name and email are updated in Agora when those same attributes are updated in Okta.
Deactivate Users. Users removed from the Agora application in Okta are automatically signed out and disabled in Agora.
Not Supported Features
Group Provisioning. Groups from Okta will not be propagated into Agora.
Group Importing. Groups and permissions from Agora will not be propagated into Okta.
Setting up Okta SCIM provisioning with Agora
We recommend being logged into both Okta and your Agora account before you get started, as there are some values you’ll need to copy and paste between the two platforms.
In Agora:
Navigate to the New API Key settings page within Agora (Settings > Organization > API > Keys > New Key)
Enter a description for a new key, for example "Okta SCIM"
Click Create
On screen will be your secret API Key, copy this and follow the below instructions in Okta
In Okta:
If already using the Agora Okta application (for example the Okta SSO) then skip to step 6
Navigate to Applications and choose Applications from the dropdown
In the Applications page, select Browse App Catalog
Search for Agora and then click on it (there may be multiple results that come back for the Agora search term. Make sure you select the one with the right logo!
Click the Add button.
Navigate to the Applications tab and select the Agora application
Navigate to the Provisioning tab
Under the Settings panel on the left side, click the Integration link
Click the Configure API Integration button
Check the Enable API Integration box then copy and paste the API Key from Agora generated earlier
Click Test API Credentials and verify that the connection is working
Click Save to save your configuration
Enabling the features
Navigate to the Applications tab and select the Agora application in Okta
Navigate to the Provisioning tab
Under the Settings panel on the left side, click the To App link
Click the Edit button at top right. Check the Enable box next to the features you would like to enable:
Create Users to allow users to be automatically provisioned into Agora whenever they are assigned to the Agora application in Okta
Update User Attributes to allow user attributes like name and email to be automatically updates into Agora whenever they are changed in Okta
Deactivate Users to automatically sign users out and deactivate their account in Agora when they are unassigned from the Agora application in Okta
Click the Save button
Disabling Okta SCIM provisioning
In Okta:
Navigate to the Applications tab and select the Agora application in Okta
Navigate to the Provisioning tab
Under the Settings panel on the left side, click the To App link
Click the Edit button at top right. Uncheck all of the Enable boxes to disable all features provided by SCIM to Agora
Click the Save button
In Agora:
Navigate to the API Keys settings page within Agora (Settings > Organization > API > Keys)
Find the API Key matching the description used in the set up step (ex: Okta SCIM)
Click Deactivate
Notes
Users created with the Create Users feature will have no permissions set in Agora by default. In order to assign those users to the correct permission groups, they will need to be found in the Users setting page and assigned the permissions (Settings > Organization > Users)
Users deactivated with the Deactivate Users feature will still exist in Agora in a disabled state and can continue to be found in the Users setting page with a greyed out name (Settings > Organization > Users)
Please contact Agora support via the chat bubble in the bottom-right corner of the platform if you run into any issues or errors