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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "computed_permissions"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/computed_permissions@
  15
  16 h2. Resource
  17
  18 Computed permissions are entries from the internal cache of the highest permission level each user has on each permission target.
  19
  20 Each entry has the following attributes:
  21
  22 table(table table-bordered table-condensed).
  23 |_. Attribute|_. Type|_. Description|
  24 |user_uuid|string|An individual user.|
  25 |target_uuid|string|An object (role group, project group, collection, etc.) on which the user has implicit or explicit permission.|
  26 |perm_level|string|@can_read@, @can_write@, or @can_manage@|
  27
  28 There is only one row for a given (@user_uuid@, @target_uuid@) pair.
  29
  30 Computed permissions cannot be created or updated directly. To change permissions, use "groups":groups.html and "links":links.html APIs as described in the "permission model":../permission-model.html.
  31
  32 h2. Method
  33
  34 h3. list
  35
  36 @GET /arvados/v1/computed_permissions@
  37
  38 List computed permissions.
  39
  40 The computed permissions API accepts the arguments described in the "common resource list method":{{site.baseurl}}/api/methods.html#index with the following exceptions:
  41 * It is an error to supply a non-zero @offset@ argument.
  42 * The default value for @order@ is @["user_uuid", "target_uuid"]@.
  43 * The default value for @count@ is @"none"@ and no other values are accepted.