users

API endpoint base: https://qr1hi.arvadosapi.com/arvados/v1/users

Object type: tpzed

Example UUID: zzzzz-tpzed-0123456789abcde

Resource

Users represent individuals with access to the Arvados cluster.

Each User has, in addition to the Common resource fields:

Attribute Type Description Example
email string
username string The username used for the user’s git repositories and virtual machine logins. Usernames must start with a letter, and contain only alphanumerics. When a new user is created, a default username is set from their e-mail address. Only administrators may change the username.
first_name string
last_name string
identity_url string
is_admin boolean
prefs hash
default_owner_uuid string
is_active boolean
writable_by array List of UUID strings identifying Groups and other Users that can modify this User object. This will include the user’s owner_uuid and, for administrators and users requesting their own User object, the requesting user’s UUID.

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new User.

Arguments:

Argument Type Description Location Example
user object query

current

Get the user associated with the provided API token.

Arguments:

Argument Type Description Location Example

delete

Delete an existing User.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the User in question. path

Arguments:

Argument Type Description Location Example
uuid string path

get

Gets a User’s metadata by UUID.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the User in question. path

list

List users.

See common resource list method.

system

Get the user record for the system user.

Arguments:

Argument Type Description Location Example

update

Update attributes of an existing User.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the User in question. path
user object The new attributes. query

update_uuid

Change the UUID of an existing user, updating all database references accordingly.

This method can only be used by an admin user. It should only be used when the affected user is idle. New references to the affected user that are established while the update_uuid operation is in progress might not be migrated as expected.

Arguments:

Argument Type Description Location Example
uuid string The current UUID of the user in question. path zzzzz-tpzed-12345abcde12345
new_uuid string The desired new UUID. It is an error to use a UUID belonging to an existing user. query zzzzz-tpzed-abcde12345abcde

setup

Set up a user. Adds the user to the “All users” group. Enables the user to invoke activate. See user management for details.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the User in question. query

activate

Check that a user has is set up and has signed all the user agreements. If so, activate the user. Users can invoke this for themselves. See user agreements for details.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the User in question. query

unsetup

Remove the user from the “All users” group and deactivate the user. See user management for details.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the User in question. path

merge

Transfer ownership of data from the “old” user account to the “new” user account. When redirect_to_new_user is true this also causes logins to the “old” account to be redirected to the “new” account. The “old” user account that was redirected becomes invisible in user listings.

See Merge user accounts , Reassign user data ownership and Linking alternate login accounts for examples of how this method is used.

Must supply either new_user_token (the currently authorized user will be the “old” user), or both new_user_uuid and old_user_uuid (the currently authorized user must be an admin).

Arguments:

Argument Type Description Location Example
new_user_token string A valid token for the “new” user query
new_user_uuid uuid The uuid of the “new” account query
old_user_uuid uuid The uuid of the “old” account query
new_owner_uuid uuid The uuid of a project to which objects owned by the “old” user will be reassigned. query
redirect_to_new_user boolean If true, also redirect login and reassign authorization credentials from “old” user to the “new” user query

Previous: groups Next: user_agreements

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.