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 query

Previous: groups Next: keep_services

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.