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