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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "user_agreements"
   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/user_agreements@
  15
  16 h2. Resource
  17
  18 This provides an API for inactive users to sign clickthrough agreements prior to being activated.
  19
  20 h2. Methods
  21
  22 Required arguments are displayed in %{background:#ccffcc}green%.
  23
  24 h3. list
  25
  26 List user agreements.  This is a list of collections which contain HTML files with the text of the clickthrough agreement(s) which can be rendered by Workbench.
  27
  28 table(table table-bordered table-condensed).
  29 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  30
  31 h3. signatures
  32
  33 List user agreements that have already been signed.  These are recorded as link objects of @{"link_class": "signature", "name": "click"}@.
  34
  35 table(table table-bordered table-condensed).
  36 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  37
  38 h3. sign
  39
  40 Sign a user agreement.
  41
  42 table(table table-bordered table-condensed).
  43 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  44 {background:#ccffcc}.|uuid|string|The UUID of the user agreement collection.|path||