X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a1f06e4e118923d301683824ccd47bcf68c8ef69..8f9a16c4e784b40e8661174fff32564e8c1c7f69:/doc/admin/user-management-cli.html.textile.liquid diff --git a/doc/admin/user-management-cli.html.textile.liquid b/doc/admin/user-management-cli.html.textile.liquid index 33969ea8f8..6892176604 100644 --- a/doc/admin/user-management-cli.html.textile.liquid +++ b/doc/admin/user-management-cli.html.textile.liquid @@ -16,7 +16,7 @@ ARVADOS_API_HOST={{ site.arvados_api_host }} ARVADOS_API_TOKEN=1234567890qwertyuiopasdfghjklzxcvbnm1234567890zzzz -In these examples, @x1u39-tpzed-3kz0nwtjehhl0u4@ is the sample user account. Replace with the uuid of the user you wish to manipulate. +In these examples, @zzzzz-tpzed-3kz0nwtjehhl0u4@ is the sample user account. Replace with the uuid of the user you wish to manipulate. See "user management":{{site.baseurl}}/admin/activation.html for an overview of how to use these commands. @@ -24,28 +24,68 @@ h3. Setup a user This creates a default git repository and VM login. Enables user to self-activate using Workbench. -
-arv user setup --uuid x1u39-tpzed-3kz0nwtjehhl0u4
-
+ +
$ arv user setup --uuid zzzzz-tpzed-3kz0nwtjehhl0u4
+
+
+ h3. Deactivate user -
-arv user unsetup --uuid x1u39-tpzed-3kz0nwtjehhl0u4
-
+ +
$ arv user unsetup --uuid zzzzz-tpzed-3kz0nwtjehhl0u4
+
+
+ When deactivating a user, you may also want to "reassign ownership of their data":{{site.baseurl}}/admin/reassign-ownership.html . h3. Directly activate user -
-arv user update --uuid "x1u39-tpzed-3kz0nwtjehhl0u4" --user '{"is_active":true}'
-
+ +
$ arv user update --uuid "zzzzz-tpzed-3kz0nwtjehhl0u4" --user '{"is_active":true}'
+
+
+ +Note: this bypasses user agreements checks, and does not set up the user with a default git repository or VM login. -Note this bypasses user agreements checks, and does not set up the user with a default git repository or VM login. +h3(#create-token). Create a token for a user +As an admin, you can create tokens for other users. + + +
$ arv api_client_authorization create --api-client-authorization '{"owner_uuid": "zzzzz-tpzed-fr97h9t4m5jffxs"}'
+{
+ "href":"/api_client_authorizations/zzzzz-gj3su-yyyyyyyyyyyyyyy",
+ "kind":"arvados#apiClientAuthorization",
+ "etag":"9yk144t0v6cvyp0342exoh2vq",
+ "uuid":"zzzzz-gj3su-yyyyyyyyyyyyyyy",
+ "owner_uuid":"zzzzz-tpzed-fr97h9t4m5jffxs",
+ "created_at":"2020-03-12T20:36:12.517375422Z",
+ "modified_by_client_uuid":null,
+ "modified_by_user_uuid":null,
+ "modified_at":null,
+ "user_id":3,
+ "api_client_id":7,
+ "api_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+ "created_by_ip_address":null,
+ "default_owner_uuid":null,
+ "expires_at":null,
+ "last_used_at":null,
+ "last_used_by_ip_address":null,
+ "scopes":["all"]
+}
+
+
+ + +To get the token string, combine the values of @uuid@ and @api_token@ in the form "v2/$uuid/$api_token". In this example the string that goes in @ARVADOS_API_TOKEN@ would be: + +
+ARVADOS_API_TOKEN=v2/zzzzz-gj3su-yyyyyyyyyyyyyyy/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
-h2. Permissions +h2. Adding Permissions h3. VM login