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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "users"
   6 ...
   7
   8 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/users@
   9
  10 Object type: @tpzed@
  11
  12 Example UUID: @zzzzz-tpzed-0123456789abcde@
  13
  14 h2. Resource
  15
  16 Users represent individuals with access to the Arvados cluster.
  17
  18 Each User has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Attribute|_. Type|_. Description|_. Example|
  22 |email|string|||
  23 |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.||
  24 |first_name|string|||
  25 |last_name|string|||
  26 |identity_url|string|||
  27 |is_admin|boolean|||
  28 |prefs|hash|||
  29 |default_owner_uuid|string|||
  30 |is_active|boolean|||
  31 |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.||
  32
  33 h2. Methods
  34
  35 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  36
  37 Required arguments are displayed in %{background:#ccffcc}green%.
  38
  39 h3. create
  40
  41 Create a new User.
  42
  43 Arguments:
  44
  45 table(table table-bordered table-condensed).
  46 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  47 |user|object||query||
  48
  49 h3. current
  50
  51 Get the user associated with the provided API token.
  52
  53 Arguments:
  54
  55 table(table table-bordered table-condensed).
  56 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  57
  58 h3. delete
  59
  60 Delete an existing User.
  61
  62 Arguments:
  63
  64 table(table table-bordered table-condensed).
  65 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  66 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
  67
  68 Arguments:
  69
  70 table(table table-bordered table-condensed).
  71 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  72 {background:#ccffcc}.|uuid|string||path||
  73
  74 h3. get
  75
  76 Gets a User's metadata by UUID.
  77
  78 Arguments:
  79
  80 table(table table-bordered table-condensed).
  81 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  82 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
  83
  84 h3. list
  85
  86 List users.
  87
  88 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  89
  90 h3. system
  91
  92 Get the user record for the "system user.":{{site.baseurl}}/api/permission-model.html#system
  93
  94 Arguments:
  95
  96 table(table table-bordered table-condensed).
  97 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  98
  99 h3. update
 100
 101 Update attributes of an existing User.
 102
 103 Arguments:
 104
 105 table(table table-bordered table-condensed).
 106 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 107 {background:#ccffcc}.|uuid|string|The UUID of the User in question.|path||
 108 |user|object||query||