blob: a74bb1e44cdbec609940567153ba340ba07f6f3c [file] [log] [blame] [edit]
<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.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="oslogin_v1beta.users.projects.locations.html">locations()</a></code>
</p>
<p class="firstline">Returns the locations Resource.</p>
<p class="toc_element">
<code><a href="oslogin_v1beta.users.projects.zones.html">zones()</a></code>
</p>
<p class="firstline">Returns the zones Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a POSIX account.</p>
<p class="toc_element">
<code><a href="#provisionPosixAccount">provisionPosixAccount(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a POSIX account if it doesn't exist.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a POSIX account.
Args:
name: string, Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format `users/{user}/projects/{project}`. (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); }
}</pre>
</div>
<div class="method">
<code class="details" id="provisionPosixAccount">provisionPosixAccount(name, body=None, x__xgafv=None)</code>
<pre>Create a POSIX account if it doesn&#x27;t exist.
Args:
name: string, Required. The unique ID for the user in format `users/{user}/projects/{project}`. (required)
body: object, The request body.
The object takes the form of:
{ # A request message for creating a POSIX account entry.
&quot;regions&quot;: [ # Optional. The regions to wait for a POSIX account to be written to before returning a response. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region.
&quot;A String&quot;,
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The POSIX account information associated with a Google account.
&quot;accountId&quot;: &quot;A String&quot;, # Output only. A POSIX account identifier.
&quot;gecos&quot;: &quot;A String&quot;, # The GECOS (user information) entry for this account.
&quot;gid&quot;: &quot;A String&quot;, # The default group ID.
&quot;homeDirectory&quot;: &quot;A String&quot;, # The path to the home directory for this account.
&quot;name&quot;: &quot;A String&quot;, # Output only. The canonical resource name.
&quot;operatingSystemType&quot;: &quot;A String&quot;, # The operating system type where this account applies.
&quot;primary&quot;: True or False, # Only one POSIX account can be marked as primary.
&quot;shell&quot;: &quot;A String&quot;, # The path to the logic shell for this account.
&quot;systemId&quot;: &quot;A String&quot;, # System identifier for which account the username or uid applies to. By default, the empty value is used.
&quot;uid&quot;: &quot;A String&quot;, # The user ID.
&quot;username&quot;: &quot;A String&quot;, # The username of the POSIX account.
}</pre>
</div>
</body></html>