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

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "authorized_keys"
   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/authorized_keys@
  12
  13 Required arguments are displayed in %{background:#ccffcc}green%.
  14
  15 h2. Resource
  16
  17 Each AuthorizedKey has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  18
  19 table(table table-bordered table-condensed).
  20 |_. Attribute|_. Type|_. Description|_. Example|
  21 |name|string|||
  22 |key_type|string|||
  23 |authorized_user_uuid|string|||
  24 |public_key|text|||
  25 |expires_at|datetime|||
  26
  27 h2. Methods
  28
  29 h3. create
  30
  31 Create a new AuthorizedKey.
  32
  33 Arguments:
  34
  35 table(table table-bordered table-condensed).
  36 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  37 |authorized_key|object||query||
  38
  39 h3. delete
  40
  41 Delete an existing AuthorizedKey.
  42
  43 Arguments:
  44
  45 table(table table-bordered table-condensed).
  46 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  47 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  48
  49 h3. get
  50
  51 Gets a AuthorizedKey's metadata by UUID.
  52
  53 Arguments:
  54
  55 table(table table-bordered table-condensed).
  56 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  57 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  58
  59 h3. list
  60
  61 List authorized_keys.
  62
  63 Arguments:
  64
  65 table(table table-bordered table-condensed).
  66 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  67 |limit|integer (default 100)|Maximum number of authorized_keys to return.|query||
  68 |order|string|Order in which to return matching authorized_keys.|query||
  69 |filters|array|Conditions for filtering authorized_keys.|query||
  70
  71 h3. update
  72
  73 Update attributes of an existing AuthorizedKey.
  74
  75 Arguments:
  76
  77 table(table table-bordered table-condensed).
  78 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  79 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  80 |authorized_key|object||query||