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