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
  16 h2. create
  17
  18 Create a new User.
  19
  20 Arguments:
  21
  22 table(table table-bordered table-condensed).
  23 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  24 |user|object||query||
  25
  26 h2. current
  27
  28 current users
  29
  30 Arguments:
  31
  32 table(table table-bordered table-condensed).
  33 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  34
  35 h2. delete
  36
  37 Delete an existing User.
  38
  39 Arguments:
  40
  41 table(table table-bordered table-condensed).
  42 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  43 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  49 {background:#ccffcc}.|uuid|string||path||
  50
  51 h2. get
  52
  53 Gets a User's metadata by UUID.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
  60
  61 h2. list
  62
  63 List users.
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69 |limit|integer (default 100)|Maximum number of users to return.|query||
  70 |order|string|Order in which to return matching users.|query||
  71 |filters|array|Conditions for filtering users.|query||
  72
  73 h2. show
  74
  75 show users
  76
  77 Arguments:
  78
  79 table(table table-bordered table-condensed).
  80 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  81 {background:#ccffcc}.|uuid|string||path||
  82
  83 h2. system
  84
  85 system users
  86
  87 Arguments:
  88
  89 table(table table-bordered table-condensed).
  90 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  91
  92 h2. update
  93
  94 Update attributes of an existing User.
  95
  96 Arguments:
  97
  98 table(table table-bordered table-condensed).
  99 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 100 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
 101 |user|object||query||