blob: 56dad2bef969c77b73fcdb172a8d6bd3a341899b [file] [log] [blame]
<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="oslogin_v1beta.html">Cloud OS Login API</a> . <a href="oslogin_v1beta.users.html">users</a> . <a href="oslogin_v1beta.users.sshPublicKeys.html">sshPublicKeys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an SSH public key.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves an SSH public key.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an SSH public key and returns the profile information. This method</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an SSH public key.
Args:
name: string, Required. The fingerprint of the public key to update. Public keys are identified by
their SHA-256 fingerprint. The fingerprint of the public key is in format
`users/{user}/sshPublicKeys/{fingerprint}`. (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>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves an SSH public key.
Args:
name: string, Required. The fingerprint of the public key to retrieve. Public keys are identified
by their SHA-256 fingerprint. The fingerprint of the public key is in
format `users/{user}/sshPublicKeys/{fingerprint}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The SSH public key information associated with a Google account.
&quot;key&quot;: &quot;A String&quot;, # Public key text in SSH format, defined by
# &lt;a href=&quot;https://www.ietf.org/rfc/rfc4253.txt&quot; target=&quot;_blank&quot;&gt;RFC4253&lt;/a&gt;
# section 6.6.
&quot;fingerprint&quot;: &quot;A String&quot;, # Output only. The SHA-256 fingerprint of the SSH public key.
&quot;expirationTimeUsec&quot;: &quot;A String&quot;, # An expiration time in microseconds since epoch.
&quot;name&quot;: &quot;A String&quot;, # Output only. The canonical resource name.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates an SSH public key and returns the profile information. This method
supports patch semantics.
Args:
name: string, Required. The fingerprint of the public key to update. Public keys are identified by
their SHA-256 fingerprint. The fingerprint of the public key is in format
`users/{user}/sshPublicKeys/{fingerprint}`. (required)
body: object, The request body.
The object takes the form of:
{ # The SSH public key information associated with a Google account.
&quot;key&quot;: &quot;A String&quot;, # Public key text in SSH format, defined by
# &lt;a href=&quot;https://www.ietf.org/rfc/rfc4253.txt&quot; target=&quot;_blank&quot;&gt;RFC4253&lt;/a&gt;
# section 6.6.
&quot;fingerprint&quot;: &quot;A String&quot;, # Output only. The SHA-256 fingerprint of the SSH public key.
&quot;expirationTimeUsec&quot;: &quot;A String&quot;, # An expiration time in microseconds since epoch.
&quot;name&quot;: &quot;A String&quot;, # Output only. The canonical resource name.
}
updateMask: string, Mask to control which fields get updated. Updates all if not present.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The SSH public key information associated with a Google account.
&quot;key&quot;: &quot;A String&quot;, # Public key text in SSH format, defined by
# &lt;a href=&quot;https://www.ietf.org/rfc/rfc4253.txt&quot; target=&quot;_blank&quot;&gt;RFC4253&lt;/a&gt;
# section 6.6.
&quot;fingerprint&quot;: &quot;A String&quot;, # Output only. The SHA-256 fingerprint of the SSH public key.
&quot;expirationTimeUsec&quot;: &quot;A String&quot;, # An expiration time in microseconds since epoch.
&quot;name&quot;: &quot;A String&quot;, # Output only. The canonical resource name.
}</pre>
</div>
</body></html>