+++ /dev/null
----
-layout: default
-navsection: admin
-title: User activation
-...
-
-{% comment %}
-Copyright (C) The Arvados Authors. All rights reserved.
-
-SPDX-License-Identifier: CC-BY-SA-3.0
-{% endcomment %}
-
-This page describes how new users are created and activated.
-
-h3. Authentication
-
-"Browser login and management of API tokens is described here.":{{site.baseurl}}/api/tokens.html
-
-After completing the log in and authentication process, the API server receives a user record from the upstream identity provider (Google OAuth, LDAP, etc) consisting of the user's name, email address, and unique identifier called the @identity_url@.
-
-The API server searches for a user record with the @identity_url@ supplied by the identity provider. If found, that user account will be used, unless the account has @redirect_to_user_uuid@ set, in which case it will use the user in @redirect_to_user_uuid@ instead (this is used for the "link account":{{site.baseurl}}/user/topics/link-accounts.html feature).
-
-If no matching @identity_url@ is found, it searches by email address. This allows for "provider migration":migrating-providers.html and a "pre-activated accounts.":#pre-activated
-
-If no existing user record is found, a new user object will be created.
-
-A federated user follows a slightly different flow, whereby a special token is presented and the API server verifies user's identity with the home cluster. This results in a user object (representing the remote user) being created on the local cluster.
-
-h3. User activation
-
-A newly created user is inactive (@is_active@ is false) by default.
-
-An inactive user cannot create or update any object, but can read Arvados objects that the user account has permission to read.
-
-There are three ways a user can be activated:
-
-# Self-activation. When a user logs in to Workbench, checks for "user agreements":#user_agreements and Workbench automatically attempts to self-activate.
-# An admin can invoke the @activate@ method of the users controller using @arv user activate --uuid=...@ (this also checks for user agreements)
-# An admin can set the @is_active@ field directly (bypassing user agreements)
-
-A user which has already been set up (either @Users.AutoSetupNewUsers@ is true, or an admin has invoked @setup@) can self-activate. The @activate@ method checks that the user has "signed" any user agreements, it will fail if they are not yet signed.
-
-If the user has _not_ yet been set up (@Users.AutoSetupNewUsers@ is false) the user cannot self-activate, and requires an admin to either @setup@ the user (enabling self activation), or directly @activate@ the user.
-
-When a user is activated, some basic setup is done, but does not perform full "user setup":#setup .
-
-* @can_login@ @permission@ link going (email address → user uuid) which records @identity_url_prefix@
-* Adding membership to the "All users" group (can read all users, all users can see new user)
-
-h3(#deactivating_users). Deactivate a user
-
-Setting @is_active@ to @false@ is *not* sufficient to lock out a user. The user may be able to use re-activate themself. The correct way is to use @unsetup@.
-
-Note: also make sure that @is_admin: false@. If the user still has @is_admin: true@ the user may be able to re-activate themself.
-
-<pre>
-$ arv user unsetup --uuid=x1u39-tpzed-3kz0nwtjehhl0u4
-</pre>
-
-* Delete oid_login_perms
-* Delete git repository permission links
-* Delete VM login permission links
-* Remove access to "All users" group
-* Delete any user agreement signatures
-* Clear preferences / profile
-* Mark as inactive
-
-Unsetup does not revoke API tokens.
-
-An "inactive" user with a valid API token can still read the database, but is barred from creating or modifying records. User deactivation with "unsetup" should be done together with "ownership reassignment.":reassign-ownership.html
-
-h3(#user_agreements). User agreements and self-activation
-
-The @activate@ method of the users controller checks if the user @is_invited@ and whether the user has "signed" all the user agreements.
-
-@is_invited@ is true if any of these are true:
-* @is_active@ is true
-* @Users.NewUsersAreActive@ is true
-* The user account has permission to view the membership of the "All Users" group.
-
-User agreements are accessed through the "user_agreements API":{{site.baseurl}}/api/methods/user_agreements.html . This returns a list of collection records. This is executed as a system user, so it bypasses normal read permission checks.
-
-The user agreements that users are required to sign should be added to the @links@ table this way:
-
-<pre>
-$ arv link create --link '{
- "link_class": "signature",
- "name": "require",
- "tail_uuid": "*system user uuid*",
- "head_uuid: "*collection uuid*"
-}'
-</pre>
-
-The collection contains a single HTML file with the user agreement text.
-
-Workbench checks @is_invited@. If true, it displays the clickthrough agreements which the user can "sign". If @is_invited@ is false, the user ends up at the "inactive user" page.
-
-The @user_agreements/sign@ endpoint creates a Link object:
-
-<pre>
-{
- "link_class": "signature"
- "name": "click",
- "tail_uuid": "*user uuid*",
- "head_uuid: "*collection uuid*"
-}
-</pre>
-
-The @user_agreements/signatures@ endpoint returns the list of Link objects that represent signatures by the current user (created by @sign@).
-
-h3(#setup). User setup
-
-A user can be setup whether they are active or not. Setting up an inactive user enables self-activation. Setup does the following things:
-
-* @can_login@ @permission@ link going (email address → user uuid) which records @identity_url_prefix@
-* Adding membership to the "All users" group (can read all users, all users can see new user)
-* If @Users.AutoSetupNewUsersWithRepository@ is true, a new default git repo and @can_manage@ permission to that repo
-* if @Users.AutoSetupNewUsersWithVmUUID@ is set, @can_login@ permission to a shell node
-
-If the cluster configuration option @Users.AutoSetupNewUsers@ is true, new users are always setup immediately. When @Users.AutoSetupNewUsers@ is true, an user who has been set up but is not activated may still be able to do things, such as read things shared with "All users", clone and push to the git repository, or login to a VM.
-
-h3. User profile
-
-The user profile is checked by workbench after checking if user agreements need to be signed. The requirement to fill out the user profile is not enforced by the API server.
-
-h3(#pre-activated). Pre-activate user by email address
-
-You may create a user account for a user that has not yet logged in, and identify the user by email address.
-
-1. As an admin, create a user object:
-
-<pre>
-$ arv user create --user '{"email": "foo@example.com", "username": "barney", "is_active": true}'
-</pre>
-
-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.
-
-h3. Pre-activate federated user
-
-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):
-
-<pre>
-$ arv user create --user '{"uuid": "clsr2-tpzed-1234567890abcdf", "email": "foo@example.com", "username": "barney", "is_active": true}'
-</pre>
-
-2. When the user logs in, they will be associated with the existing user object.
-
-h3. Auto-activate federated users from trusted clusters
-
-In the API server config, set @ActivateUsers: true@ for each federated cluster in @RemoteClusters@ . A federated user from one of the listed clusters which @is_active@ on the home cluster will be automatically set up and activated on this cluster.
-
-h3. Activation flows
-
-h4. Private instance
-
-Policy: users must be manually activated by the admin.
-
-Here is the configuration for this policy. This is also the default if not provided.
-(However, be aware this is not how developer/demo builds such as "arvbox":{{site.baseurl}}/install/arvbox.html are configured.)
-
-<pre>
-Users:
- AutoSetupNewUsers: false
- NewUsersAreActive: false
-</pre>
-
-# User is created. Not set up. @is_active@ is false.
-# Workbench checks @is_invited@ and finds it is false. User gets "inactive user" page.
-# Admin goes to user page and clicks either "setup user" or manually @is_active@ to true.
-# Clicking "setup user" sets up the user. This includes adding the user to "All users" which qualifies the user as @is_invited@.
-# On refreshing workbench, the user is still inactive, but is able to self-activate after signing clickthrough agreements (if any).
-# Alternately, directly setting @is_active@ to true also sets up the user, but workbench won't display clickthrough agreements (because the user is already active).
-
-h4. Federated instance
-
-Policy: users other clusters in the federation are activated, users from outside the federation must be manually approved.
-
-Here is the configuration for this policy and an example remote cluster @clsr2@.
-
-<pre>
-Users:
- AutoSetupNewUsers: false
- NewUsersAreActive: false
-RemoteClusters:
- clsr2:
- ActivateUsers: true
-</pre>
-
-# Federated user arrives claiming to be from cluster 'clsr2'
-# API server authenticates user as being from cluster 'clsr2'
-# Because 'clsr2' has @ActivateUsers@ the user is set up and activated.
-# User can immediately start using Workbench.
-
-h4. Open instance
-
-Policy: anybody who shows up and signs the agreements is activated.
-
-<pre>
-Users:
- AutoSetupNewUsers: true
- NewUsersAreActive: false
-</pre>
-
-"Set up user agreements":#user_agreements by creating "signature" "require" links as described earlier.
-
-# User is created and auto-setup. At this point, @is_active@ is false, but user has been added to "All users" group.
-# Workbench checks @is_invited@ and finds it is true, because the user is a member of "All users" group.
-# Workbench presents user with list of user agreements, user reads and clicks "sign" for each one.
-# Workbench tries to activate user.
-# User is activated.
-
-h4. Developer instance
-
-Policy: avoid wasting developer's time during development/testing. Insecure.
-
-<pre>
-Users:
- AutoSetupNewUsers: true
- NewUsersAreActive: true
-</pre>
-
-# User is created, immediately auto-setup, and auto-activated.
-# User can immediately start using workbench.
projects / arvados.git / blobdiff