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
  10
  11 Required arguments are displayed in %{background:#ccffcc}green%.
  12
  13
  14 h2. create
  15
  16 Create a new AuthorizedKey.
  17
  18 Arguments:
  19
  20 table(table table-bordered table-condensed).
  21 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  22 |authorized_key|object||query||
  23
  24 h2. delete
  25
  26 Delete an existing AuthorizedKey.
  27
  28 Arguments:
  29
  30 table(table table-bordered table-condensed).
  31 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  32 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  33
  34 h2. destroy
  35
  36 destroy authorized_keys
  37
  38 Arguments:
  39
  40 table(table table-bordered table-condensed).
  41 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  42 {background:#ccffcc}.|uuid|string||path||
  43
  44 h2. get
  45
  46 Gets a AuthorizedKey's metadata by UUID.
  47
  48 Arguments:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  52 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  53
  54 h2. list
  55
  56 List authorized_keys.
  57
  58 Arguments:
  59
  60 table(table table-bordered table-condensed).
  61 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  62 |limit|integer (default 100)|Maximum number of authorized_keys to return.|query||
  63 |order|string|Order in which to return matching authorized_keys.|query||
  64 |filters|array|Conditions for filtering authorized_keys.|query||
  65
  66 h2. update
  67
  68 Update attributes of an existing AuthorizedKey.
  69
  70 Arguments:
  71
  72 table(table table-bordered table-condensed).
  73 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  74 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  75 |authorized_key|object||query||