doc/admin/migrating-providers.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: Changing upstream login providers
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 This page describes how to enable users to use more than one upstream identity provider to log into the same Arvados account.  This can be used to migrate account providers, for example, from LDAP to Google.  In order to do this, users must be able to log into both the "old" and "new" providers.
  13
  14 h2. Configure multiple or alternate provider in SSO
  15
  16 In @application.yml@ for the SSO server, you can enable both @google_oauth2@ and @ldap@ providers:
  17
  18 <pre>
  19 production:
  20   google_oauth2_client_id: abcd
  21   google_oauth2_client_secret: abcd
  22
  23   use_ldap:
  24     title: Example LDAP
  25     host: ldap.example.com
  26     port: 636
  27     method: ssl
  28     base: "ou=Users, dc=example, dc=com"
  29     uid: uid
  30     username: uid
  31 </pre>
  32
  33 Restart the SSO server after changing the configuration.
  34
  35 h2. Matching on email address
  36
  37 If the new account provider supplies an email address (primary or alternate) that matches an existing user account, the user will be logged into that account.  No further migration is necessary, and the old provider can be removed from the SSO configuration.
  38
  39 h2. Link accounts
  40
  41 If the new provider cannot provide matching email addresses, users will have to migrate manually by "linking accounts":{{site.baseurl}}/user/topics/link-accounts.html
  42
  43 After linking accounts, users can use the new provider to access their existing Arvados account.
  44
  45 Once all users have migrated, the old account provider can be removed from the SSO configuration.