Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / cloudshell_v1alpha1.users.environments.publicKeys.html
blob: dc0374acbf98bc93456215d00cc0fe2648a3f131 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudshell_v1alpha1.html">Cloud Shell API</a> . <a href="cloudshell_v1alpha1.users.html">users</a> . <a href="cloudshell_v1alpha1.users.environments.html">environments</a> . <a href="cloudshell_v1alpha1.users.environments.publicKeys.html">publicKeys</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Adds a public SSH key to an environment, allowing clients with the</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Removes a public SSH key from an environment. Clients will no longer be</p>
83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]85 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <pre>Adds a public SSH key to an environment, allowing clients with the
87corresponding private key to connect to that environment via SSH. If a key
88with the same format and content already exists, this will return the
89existing key.
90
91Args:
92 parent: string, Parent resource name, e.g. `users/me/environments/default`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94 The object takes the form of:
95
96{ # Request message for CreatePublicKey.
97 "key": { # A public SSH key, corresponding to a private SSH key held by the client. # Key that should be added to the environment.
98 "name": "A String", # Output only. Full name of this resource, in the format
99 # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
100 # `{owner_email}` is the email address of the user to whom the key belongs.
101 # `{environment_id}` is the identifier of the environment to which the key
102 # grants access. `{key_id}` is the unique identifier of the key. For example,
103 # `users/someone@example.com/environments/default/publicKeys/myKey`.
104 "key": "A String", # Required. Content of this key.
105 "format": "A String", # Required. Format of this key's content.
106 },
107 }
108
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
117 { # A public SSH key, corresponding to a private SSH key held by the client.
118 "name": "A String", # Output only. Full name of this resource, in the format
119 # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.
120 # `{owner_email}` is the email address of the user to whom the key belongs.
121 # `{environment_id}` is the identifier of the environment to which the key
122 # grants access. `{key_id}` is the unique identifier of the key. For example,
123 # `users/someone@example.com/environments/default/publicKeys/myKey`.
124 "key": "A String", # Required. Content of this key.
125 "format": "A String", # Required. Format of this key's content.
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
131 <pre>Removes a public SSH key from an environment. Clients will no longer be
132able to connect to the environment using the corresponding private key.
133
134Args:
135 name: string, Name of the resource to be deleted, e.g.
136`users/me/environments/default/publicKeys/my-key`. (required)
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142Returns:
143 An object of the form:
144
145 { # A generic empty message that you can re-use to avoid defining duplicated
146 # empty messages in your APIs. A typical example is to use it as the request
147 # or the response type of an API method. For instance:
148 #
149 # service Foo {
150 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
151 # }
152 #
153 # The JSON representation for `Empty` is empty JSON object `{}`.
154 }</pre>
155</div>
156
157</body></html>