| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds a public SSH key to an environment, allowing clients with the</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Removes a public SSH key from an environment. Clients will no longer be</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body, x__xgafv=None)</code> |
| <pre>Adds a public SSH key to an environment, allowing clients with the |
| corresponding private key to connect to that environment via SSH. If a key |
| with the same format and content already exists, this will return the |
| existing key. |
| |
| Args: |
| parent: string, Parent resource name, e.g. `users/me/environments/default`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Request message for CreatePublicKey. |
| "key": { # A public SSH key, corresponding to a private SSH key held by the client. # Key that should be added to the environment. |
| "name": "A String", # Output only. Full name of this resource, in the format |
| # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. |
| # `{owner_email}` is the email address of the user to whom the key belongs. |
| # `{environment_id}` is the identifier of the environment to which the key |
| # grants access. `{key_id}` is the unique identifier of the key. For example, |
| # `users/[email protected]/environments/default/publicKeys/myKey`. |
| "key": "A String", # Required. Content of this key. |
| "format": "A String", # Required. Format of this key's content. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A public SSH key, corresponding to a private SSH key held by the client. |
| "name": "A String", # Output only. Full name of this resource, in the format |
| # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. |
| # `{owner_email}` is the email address of the user to whom the key belongs. |
| # `{environment_id}` is the identifier of the environment to which the key |
| # grants access. `{key_id}` is the unique identifier of the key. For example, |
| # `users/[email protected]/environments/default/publicKeys/myKey`. |
| "key": "A String", # Required. Content of this key. |
| "format": "A String", # Required. Format of this key's content. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Removes a public SSH key from an environment. Clients will no longer be |
| able to connect to the environment using the corresponding private key. |
| |
| Args: |
| name: string, Name of the resource to be deleted, e.g. |
| `users/me/environments/default/publicKeys/my-key`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated |
| # empty messages in your APIs. A typical example is to use it as the request |
| # or the response type of an API method. For instance: |
| # |
| # service Foo { |
| # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| # } |
| # |
| # The JSON representation for `Empty` is empty JSON object `{}`. |
| }</pre> |
| </div> |
| |
| </body></html> |