doc/api/methods/users.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "users"
   6
   7 ...
   8
   9 See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html
  10
  11 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/users@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  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.||
  31
  32 h2. Methods
  33
  34 h3. create
  35
  36 Create a new User.
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 |user|object||query||
  43
  44 h3. current
  45
  46 current users
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52
  53 h3. delete
  54
  55 Delete an existing User.
  56
  57 Arguments:
  58
  59 table(table table-bordered table-condensed).
  60 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  61 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
  62
  63 Arguments:
  64
  65 table(table table-bordered table-condensed).
  66 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  67 {background:#ccffcc}.|uuid|string||path||
  68
  69 h3. get
  70
  71 Gets a User's metadata by UUID.
  72
  73 Arguments:
  74
  75 table(table table-bordered table-condensed).
  76 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  77 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
  78
  79 h3. list
  80
  81 List users.
  82
  83 Arguments:
  84
  85 table(table table-bordered table-condensed).
  86 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  87 |limit|integer (default 100)|Maximum number of users to return.|query||
  88 |order|string|Order in which to return matching users.|query||
  89 |filters|array|Conditions for filtering users.|query||
  90
  91 h3. show
  92
  93 show users
  94
  95 Arguments:
  96
  97 table(table table-bordered table-condensed).
  98 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  99 {background:#ccffcc}.|uuid|string||path||
 100
 101 h3. system
 102
 103 system users
 104
 105 Arguments:
 106
 107 table(table table-bordered table-condensed).
 108 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 109
 110 h3. update
 111
 112 Update attributes of an existing User.
 113
 114 Arguments:
 115
 116 table(table table-bordered table-condensed).
 117 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 118 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
 119 |user|object||query||