SCIM

~ minute read

What is SCIM?

SCIM is an open standard that allows for the automation of user provisioning. SCIM is used by Single Sign-On (SSO) Services and identity providers to manage people across multiple domains. 

 

Configuring SCIM

If you're configuring with Okta, follow our guide found here.

Step One: Enable SCIM in UserVoice

To find the setting, go to General Settings -> User Authentication and enable SCIM by toggling the feature "On". Once enabled, click "Create Token" to obtain the API Token for configuring in your IdP.

Note: Admins with owner-level permissions are the only admins able to enable and obtain the token. 

 

Step Two: Configure within your Identity Provider

UserVoice supports SCIM v2. Setup will depend upon which Identity Provider you use as long as it allows setting up SCIM v2. During the configuration, you will need to enter the Base URL https://yourdomain.uservoice.com/api/scim_v2 and Token obtained from Step One. 

Common IdP’s that will support SCIM v2 are Okta and Azure.

 

Supported Features

  • Assign License
    • Pass a licenseType for users to determine which license type they are provisioned. 
  • Assign User Traits
  • Deactivate License 
    • When deleting or deactivating a user via the IdP or SCIM, this will only deactivate their license within UserVoice. The user will be moved from one of the Licensed Types to End-User.

 

Attributes

SCIM Attribute

UserVoice Field
Variables Permission Reference
licenseType Capture Feedback Internal Roadmap Idea Management Settings
fullaccess_owner

On

View & Edit

View & Edit

Full edit

admin

On

View & Edit

View & Edit

Partial

admin_no_settings

On

View & Edit

View & Edit

Disabled

readonly_admin

On

View & Edit

View only

Disabled
admin_ideas_only

On

Disabled

View & Edit

Disabled
admin_feedback_only

On

Disabled

View only

Disabled

contributor

On

Disabled

Disabled

Disabled

none

Off

N/A

N/A

N/A
userName email

Note: Once SCIM has been configured, any further provisioning of licenses (add/removing/updating) will be done through the IdP.  If attempted within the UI, changes will not be saved.

Related articles