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 h2. event_stream
  46
  47 event_stream users
  48
  49 Arguments:
  50
  51 table(table table-bordered table-condensed).
  52 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  53 {background:#ccffcc}.|uuid|string||path||
  54
  55 h2. get
  56
  57 Gets a User's metadata by UUID.
  58
  59 Arguments:
  60
  61 table(table table-bordered table-condensed).
  62 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  63 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
  64
  65 h2. list
  66
  67 List users.
  68
  69 Arguments:
  70
  71 table(table table-bordered table-condensed).
  72 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  73 |limit|integer (default 100)|Maximum number of users to return.|query||
  74 |order|string|Order in which to return matching users.|query||
  75 |filters|array|Conditions for filtering users.|query||
  76
  77 h2. owned_items
  78
  79 Retrieve a list of items which are owned by the given user.
  80
  81 Arguments:
  82
  83 table(table table-bordered table-condensed).
  84 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  85 {background:#ccffcc}.|uuid|string|The UUID of the user in question.|path||
  86 |include_linked|boolean|If true, results will also include items on which the given user has _can_manage_ permission, even if they are owned by different users/groups.|path|{white-space:nowrap}. @false@ (default)
  87 @true@|
  88
  89 h2. show
  90
  91 show users
  92
  93 Arguments:
  94
  95 table(table table-bordered table-condensed).
  96 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  97 {background:#ccffcc}.|uuid|string||path||
  98
  99 h2. system
 100
 101 system users
 102
 103 Arguments:
 104
 105 table(table table-bordered table-condensed).
 106 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 107
 108 h2. update
 109
 110 Update attributes of an existing User.
 111
 112 Arguments:
 113
 114 table(table table-bordered table-condensed).
 115 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 116 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
 117 |user|object||query||