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 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/authorized_keys@
  10
  11 Object type: @fngyi@
  12
  13 Example UUID: @zzzzz-fngyi-0123456789abcde@
  14
  15 h2. Resource
  16
  17 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@.
  18
  19 Each AuthorizedKey has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  20
  21 table(table table-bordered table-condensed).
  22 |_. Attribute|_. Type|_. Description|_. Example|
  23 |name|string|A name to help the user manage their keys.||
  24 |key_type|string|Public key type, currently only supports "SSH"||
  25 |authorized_user_uuid|string|The user to which this key belongs.  Authentication using this key authenticates as this user.||
  26 |public_key|text|The actual public key material, e.g., from @~/.ssh/id_rsa.pub@||
  27 |expires_at|datetime|Expiration date after which the key is no longer valid.||
  28
  29 h2. Methods
  30
  31 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  32
  33 Required arguments are displayed in %{background:#ccffcc}green%.
  34
  35 h3. create
  36
  37 Create a new AuthorizedKey.
  38
  39 Arguments:
  40
  41 table(table table-bordered table-condensed).
  42 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  43 |authorized_key|object||query||
  44
  45 h3. delete
  46
  47 Delete an existing AuthorizedKey.
  48
  49 Arguments:
  50
  51 table(table table-bordered table-condensed).
  52 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  53 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  54
  55 h3. get
  56
  57 Gets a AuthorizedKey's metadata by UUID.
  58
  59 Arguments:
  60
  61 table(table table-bordered table-condensed).
  62 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  63 {background:#ccffcc}.|uuid|string|The UUID of the AuthorizedKey in question.|path||
  64
  65 h3. list
  66
  67 List authorized_keys.
  68
  69 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  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||