doc/admin/user-management.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: admin
   4 title: User management
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 {% comment %}
  14 TODO: Link to relevant workbench documentation when it gets written
  15 {% endcomment %}
  16
  17 This page describes how user accounts are created, set up and activated.
  18
  19 h2. Authentication
  20
  21 "Browser login and management of API tokens is described here.":{{site.baseurl}}/api/tokens.html
  22
  23 After completing the log in and authentication process, the API server receives a user record from the upstream identity provider (Google, LDAP, etc) consisting of the user's name, primary email address, alternate email addresses, and optional unique provider identifier (@identity_url@).
  24
  25 If a provider identifier is given, the API server searches for a matching user record.
  26
  27 If a provider identifier is not given, no match is found, it next searches by primary email and then alternate email address.  This enables "provider migration":migrating-providers.html and "pre-activated accounts.":#pre-activated
  28
  29 If no user account is found, a new user account is created with the information from the identity provider.
  30
  31 If a user account has been "linked":{{site.baseurl}}/user/topics/link-accounts.html or "migrated":merge-remote-account.html the API server may follow internal redirects (@redirect_to_user_uuid@) to select the linked or migrated user account.
  32
  33 h3. Federated Authentication
  34
  35 A federated user follows a slightly different flow.  The client presents a token issued by the remote cluster.  The local API server contacts the remote cluster to verify the user's identity.  This results in a user object (representing the remote user) being created on the local cluster.  If the user cannot be verified, the token will be rejected.  If the user is inactive on the remote cluster, a user record will be created, but it will also be inactive.
  36
  37 h2. User activation
  38
  39 This section describes the different user account states.
  40
  41 !(side){{site.baseurl}}/images/user-account-states.svg!
  42
  43 notextile. <div class="spaced-out">
  44
  45 # A new user record is not set up, and not active.  An inactive user cannot create or update any object, but can read Arvados objects that the user account has permission to read (such as publicly available items readable by the "anonymous" user).
  46 # Using Workbench or the "command line":{{site.baseurl}}/install/cheat_sheet.html , the admin invokes @setup@ on the user.  The setup method adds the user to the "All users" group.
  47 - If "Users.AutoSetupNewUsers":config.html is true, this happens automatically during user creation, so in that case new users start at step (3).
  48 - If "Users.AutoSetupNewUsersWithRepository":config.html is true, a new git repo is created for the user.
  49 - If "Users.AutoSetupNewUsersWithVmUUID":config.html is set, the user is given login permission to the specified shell node
  50 # User is set up, but still not yet active.  The browser presents "user agreements":#user_agreements (if any) and then invokes the user @activate@ method on the user's behalf.
  51 # The user @activate@ method checks that all "user agreements":#user_agreements are signed.  If so, or there are no user agreements, the user is activated.
  52 # The user is active.  User has normal access to the system.
  53 # From steps (1) and (3), an admin user can directly update the @is_active@ flag.  This bypasses enforcement that user agreements are signed.
  54 If the user was not yet set up (still in step (1)), it adds the user to the "All users", but bypasses creating default git repository and assigning default VM access.
  55 # An existing user can have their access revoked using @unsetup@ and "ownership reassigned":reassign-ownership.html .
  56 Unsetup removes the user from the "All users" group and makes them inactive, preventing them from re-activating themselves.
  57 "Ownership reassignment":reassign-ownership.html moves any objects or permission from the old user to a new user and deletes any credentials for the old user.
  58
  59 notextile. </div>
  60
  61 User management can be performed through the web using Workbench or the command line.  See "user management at the CLI":{{site.baseurl}}/install/cheat_sheet.html for specific examples.
  62
  63 h2(#user_agreements). User agreements and self-activation
  64
  65 The @activate@ method of the users controller checks if the user account is part of the "All Users" group and whether the user has "signed" all the user agreements.
  66
  67 User agreements are accessed through the "user_agreements API":{{site.baseurl}}/api/methods/user_agreements.html .  This returns a list of collection records.
  68
  69 The user agreements that users are required to sign should be added to the @links@ table this way:
  70
  71 <pre>
  72 $ arv link create --link '{
  73   "link_class": "signature",
  74   "name": "require",
  75   "tail_uuid": "*system user uuid*",
  76   "head_uuid: "*collection uuid*"
  77 }'
  78 </pre>
  79
  80 The collection should contain a single HTML file with the user agreement text.
  81
  82 Workbench displays the clickthrough agreements which the user can "sign".
  83
  84 The @user_agreements/sign@ endpoint creates a Link object:
  85
  86 <pre>
  87 {
  88   "link_class": "signature"
  89   "name": "click",
  90   "tail_uuid": "*user uuid*",
  91   "head_uuid: "*collection uuid*"
  92 }
  93 </pre>
  94
  95 The @user_agreements/signatures@ endpoint returns the list of Link objects that represent signatures by the current user (created by @sign@).
  96
  97 h2. User profile
  98
  99 The fields making up the user profile are described in @Workbench.UserProfileFormFields@ .  See "Configuration reference":config.html .
 100
 101 The user profile is checked by workbench after checking if user agreements need to be signed.  The values entered are stored in the @properties@ field on the user object.  Unlike user agreements, the requirement to fill out the user profile is not enforced by the API server.
 102
 103 h2. User visibility
 104
 105 Initially, a user is not part of any groups and will not be able to interact with other users on the system.  The admin should determine who the user is permited to interact with and use Workbench or the "command line":group-management.html#add to create and add the user to the appropriate group(s).
 106
 107 h2(#pre-activated). Pre-setup user by email address
 108
 109 You may create a user account for a user that has not yet logged in, and identify the user by email address.
 110
 111 1. As an admin, create a user object:
 112
 113 <pre>
 114 $ arv --format=uuid user create --user '{"email": "foo@example.com", "username": "foo"}'
 115 clsr1-tpzed-1234567890abcdf
 116 $ arv user setup --uuid clsr1-tpzed-1234567890abcdf
 117 </pre>
 118
 119 2. When the user logs in the first time, the email address will be recognized and the user will be associated with the existing user object.
 120
 121 h2. Pre-activate federated user
 122
 123 1. As admin, create a user object with the @uuid@ of the federated user (this is the user's uuid on their home cluster, called @clsr2@ in this example):
 124
 125 <pre>
 126 $ arv user create --user '{"uuid": "clsr2-tpzed-1234567890abcdf", "email": "foo@example.com", "username": "foo", "is_active": true}'
 127 </pre>
 128
 129 2. When the user logs in, they will be associated with the existing user object.
 130
 131 h2. Auto-setup federated users from trusted clusters
 132
 133 By setting @ActivateUsers: true@ for each federated cluster in @RemoteClusters@, a federated user from one of the listed clusters will be automatically set up and activated on this cluster.  See configuration example in "Federated instance":#federated .
 134
 135 h2. Activation flows
 136
 137 h3. Private instance
 138
 139 Policy: users must be manually set up by the admin.
 140
 141 Here is the configuration for this policy.  This is also the default if not provided.
 142 (However, be aware that developer/demo builds such as "arvbox":{{site.baseurl}}/install/arvbox.html are configured with the "Open instance" policy described below.)
 143
 144 <pre>
 145 Users:
 146   AutoSetupNewUsers: false
 147 </pre>
 148
 149 # User is created.  Not set up.  @is_active@ is false.
 150 # Workbench checks @is_invited@ and finds it is false.  User gets "inactive user" page.
 151 # Admin goes to user page and clicks "setup user" or sets @is_active@ to true.
 152 # On refreshing workbench, the user is able to self-activate after signing clickthrough agreements (if any).
 153 # Alternately, directly setting @is_active@ to true also sets up the user, but skips clickthrough agreements (because the user is already active).
 154
 155 h3(#federated). Federated instance
 156
 157 Policy: users from other clusters in the federation are activated, users from outside the federation must be manually approved.
 158
 159 Here is the configuration for this policy and an example remote cluster @clsr2@.
 160
 161 <pre>
 162 Users:
 163   AutoSetupNewUsers: false
 164 RemoteClusters:
 165   clsr2:
 166     ActivateUsers: true
 167 </pre>
 168
 169 # Federated user arrives claiming to be from cluster 'clsr2'
 170 # API server authenticates user as being from cluster 'clsr2'
 171 # Because 'clsr2' has @ActivateUsers@ the user is set up and activated.
 172 # User can immediately start using Workbench.
 173
 174 h3. Open instance
 175
 176 Policy: anybody who shows up and signs the agreements is activated.
 177
 178 <pre>
 179 Users:
 180   AutoSetupNewUsers: true
 181 </pre>
 182
 183 "Set up user agreements":#user_agreements by creating "signature" "require" links as described earlier.
 184
 185 # User is created and auto-setup.  At this point, @is_active@ is false, but user has been added to "All users" group.
 186 # Workbench checks @is_invited@ and finds it is true, because the user is a member of "All users" group.
 187 # Workbench presents user with list of user agreements, user reads and clicks "sign" for each one.
 188 # Workbench tries to activate user.
 189 # User is activated.