doc/api/schema/User.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: User
   6
   7 ...
   8
   9 A **User** represents a person who interacts with Arvados via an ApiClient.
  10
  11 h2. Methods
  12
  13 See "users":{{site.baseurl}}/api/methods/users.html
  14
  15 h2. Resource
  16
  17 Each User has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  18
  19 table(table table-bordered table-condensed).
  20 |_. Attribute|_. Type|_. Description|_. Example|
  21 |email|string|||
  22 |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.||
  23 |first_name|string|||
  24 |last_name|string|||
  25 |identity_url|string|||
  26 |is_admin|boolean|||
  27 |prefs|hash|||
  28 |default_owner_uuid|string|||
  29 |is_active|boolean|||
  30 |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.||