Vimeo
=====

Backend classes
---------------

For Django, choose from these class paths for ``AUTHENTICATION_BACKENDS``.
For other integrations, use the same class paths in the
framework-specific backend setting.

.. list-table::
   :header-rows: 1

   * - Backend name
     - Class path
   * - ``vimeo``
     - ``social_core.backends.vimeo.VimeoOAuth1``
   * - ``vimeo-oauth2``
     - ``social_core.backends.vimeo.VimeoOAuth2``

Vimeo uses OAuth1 to grant access to their API. In order to get the backend
running follow:

- Register an application at `Vimeo Developer Portal`_ filling the required
  settings. Ensure to fill ``App Callback URL`` field with
  ``http://<your hostname>/complete/vimeo/``

- Fill in the **Client Id** and **Client Secret** values in your settings::

    SOCIAL_AUTH_VIMEO_KEY = ''
    SOCIAL_AUTH_VIMEO_SECRET = ''

- Specify scopes with::

    SOCIAL_AUTH_VIMEO_SCOPE = [...]

- Add the backend to ``AUTHENTICATION_BACKENDS``::

    AUTHENTICATION_BACKENDS = (
        ...
        'social_core.backends.vimeo.VimeoOAuth1',
        ...
    )

.. _Vimeo Developer Portal: https://developer.vimeo.com/apps/new