Enterprise accounts with SSO enabled can use SCIM to create and manage team member accounts and user groups on Vimeo. SCIM (System for Cross-domain Identity Management) is a standard for automating the exchange of user identity information between identity domains or IT systems.
This guide will walk through how to set up a SCIM connection with Vimeo for your organization; you can check configuring with IdP (Identity Provider) Okta and Azure. The instructions for configuring with other providers (OneLogin, GSuite, Azure, etc.) should be similar.
If you’re an existing Vimeo Enterprise customer and don’t have SCIM, please contact your Account Manager for more information. If you are not a Vimeo Enterprise customer yet and are interested in SCIM, please contact us.
In this article:
Glossary
- SCIM - System for Cross-domain Identity Management is a standard for automating the exchange of user identity information between identity domains, or IT systems.
- Identity provider (IdP or IDP) is a system entity that creates, maintains, and manages identity information for principals and also provides authentication services to dependent applications within a federation or distributed network.
- Service provider (SP) - is usually a SaaS application, like Vimeo, that needs a subset of information from IdP.
Why use SCIM?
If you’re new to SCIM, here are a few examples of how it can be helpful and how your IdP (Identity Provider, such as Okta, OneLogin, GSuite, etc.) can interact with your Vimeo account:
-
Push Users: When an employee joins your organization, they will automatically have a Vimeo account created with respective group membership information and personalized content.
-
Deactivate Users: When an employee leaves your organization, their account is automatically deactivated to ensure they don’t have access to your Vimeo account, and that they’re not taking any of the seats you’re paying for.
-
Update User Attributes: When an employee changes their name or email address, their respective Vimeo account will get updated immediately. Also, When you’ve reassigned an employee to a different department and changed their group membership, their group membership is immediately updated on the Vimeo account, which updates what content they can access on Vimeo.
-
Push Groups: New groups created through Okta will also be created on Vimeo.
-
Import Users: New users created in Vimeo can be downloaded in the Import tab of the App and turned into new AppUser objects, for matching against existing Okta users.
-
Import Groups: New groups created in Vimeo can be downloaded in the Import tab of the App and turned into new AppUser objects, for matching against existing Okta groups.
-
In general, if you need to manage thousands of accounts, SCIM is the most practical way to do this.
Prerequisites
To use SCIM with your Vimeo account:
- Your Vimeo account should have an Enterprise membership and SSO enabled.
- SSO should be configured and enabled on the IdP side.
- IdP must support SCIM version 2; Vimeo does not support SCIM version 1.
When setting up SCIM provisioning for an Enterprise account, Vimeo takes extra precautions to ensure existing Vimeo users being provisioned to the Enterprise account are aware of their transition to a new team. If the existing user’s account does not have a domain claimed by the Enterprise, they will be required to accept a verification email before they can be successfully provisioned to the team. During this process, their status will appear as 'Pending' on the team management page until they accept the invitation. However, if the user's email domain has already been claimed by the enterprise, no verification is required, as the domain claim confirms their affiliation with the company. This ensures a secure and seamless SCIM provisioning experience.
Get an API Token from Vimeo
You will need to get an API token from Vimeo to get started. You must log in to the Owner account in order to do this; team members cannot access API.
- Open https://developer.vimeo.com
- Select Get started or New app.
-
Fill out the form, then select Create App.
⚠️Note: For the question asking if other users will access your app, select No. - Scroll down to the Generate an access token section.
- Select Authenticated (you).
- Select Private, then Scim scopes.
-
Click Generate.
- Copy or save the newly generated token somewhere, such as a note-taking application. Do not skip this step; you will need it later.
Please work with your Vimeo success team to enable SCIM on your Vimeo Enterprise account, and contact scim-support@vimeo.com if you have further technical questions related to SCIM.