1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
<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_v1alpha.html">Cloud OS Login API</a> . <a href="oslogin_v1alpha.users.html">users</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="oslogin_v1alpha.users.projects.html">projects()</a></code>
</p>
<p class="firstline">Returns the projects Resource.</p>
<p class="toc_element">
<code><a href="oslogin_v1alpha.users.sshPublicKeys.html">sshPublicKeys()</a></code>
</p>
<p class="firstline">Returns the sshPublicKeys 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="#getLoginProfile">getLoginProfile(name, operatingSystemType=None, projectId=None, systemId=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.</p>
<p class="toc_element">
<code><a href="#importSshPublicKey">importSshPublicKey(parent, body=None, projectId=None, regions=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.</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="getLoginProfile">getLoginProfile(name, operatingSystemType=None, projectId=None, systemId=None, view=None, x__xgafv=None)</code>
<pre>Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
Args:
name: string, Required. The unique ID for the user in format `users/{user}`. (required)
operatingSystemType: string, Optional. The type of operating system associated with the account.
Allowed values
OPERATING_SYSTEM_TYPE_UNSPECIFIED - The operating system type associated with the user account information is unspecified.
LINUX - Linux user account information.
WINDOWS - Windows user account information.
projectId: string, Required. The project ID of the Google Cloud Platform project.
systemId: string, Optional. A system ID for filtering the results of the request.
view: string, The view configures whether to retrieve security keys information.
Allowed values
LOGIN_PROFILE_VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view.
BASIC - Includes POSIX and SSH key information.
SECURITY_KEY - Include security key information for the user.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The user profile information used for logging in to a virtual machine on Google Compute Engine.
"name": "A String", # Required. A unique user ID.
"posixAccounts": [ # The list of POSIX accounts associated with the user.
{ # The POSIX account information associated with a Google account.
"accountId": "A String", # Output only. A POSIX account identifier.
"gecos": "A String", # The GECOS (user information) entry for this account.
"gid": "A String", # The default group ID.
"homeDirectory": "A String", # The path to the home directory for this account.
"name": "A String", # Output only. The canonical resource name.
"operatingSystemType": "A String", # The operating system type where this account applies.
"primary": True or False, # Only one POSIX account can be marked as primary.
"shell": "A String", # The path to the logic shell for this account.
"systemId": "A String", # System identifier for which account the username or uid applies to. By default, the empty value is used.
"uid": "A String", # The user ID.
"username": "A String", # The username of the POSIX account.
},
],
"securityKeys": [ # The registered security key credentials for a user.
{ # The credential information for a Google registered security key.
"deviceNickname": "A String", # The security key nickname explicitly set by the user.
"privateKey": "A String", # Hardware-backed private key text in SSH format.
"publicKey": "A String", # Public key text in SSH format, defined by [RFC4253]("https://www.ietf.org/rfc/rfc4253.txt") section 6.6.
"universalTwoFactor": { # Security key information specific to the U2F protocol. # The U2F protocol type.
"appId": "A String", # Application ID for the U2F protocol.
},
"webAuthn": { # Security key information specific to the Web Authentication protocol. # The Web Authentication protocol type.
"rpId": "A String", # Relying party ID for Web Authentication.
},
},
],
"sshPublicKeys": { # A map from SSH public key fingerprint to the associated key object.
"a_key": { # The SSH public key information associated with a Google account.
"expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
"fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
"key": "A String", # Required. Public key text in SSH format, defined by [RFC4253](https://www.ietf.org/rfc/rfc4253.txt) section 6.6.
"name": "A String", # Output only. The canonical resource name.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="importSshPublicKey">importSshPublicKey(parent, body=None, projectId=None, regions=None, view=None, x__xgafv=None)</code>
<pre>Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.
Args:
parent: string, The unique ID for the user in format `users/{user}`. (required)
body: object, The request body.
The object takes the form of:
{ # The SSH public key information associated with a Google account.
"expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
"fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
"key": "A String", # Required. Public key text in SSH format, defined by [RFC4253](https://www.ietf.org/rfc/rfc4253.txt) section 6.6.
"name": "A String", # Output only. The canonical resource name.
}
projectId: string, The project ID of the Google Cloud Platform project.
regions: string, 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. (repeated)
view: string, The view configures whether to retrieve security keys information.
Allowed values
LOGIN_PROFILE_VIEW_UNSPECIFIED - The default login profile view. The API defaults to the BASIC view.
BASIC - Includes POSIX and SSH key information.
SECURITY_KEY - Include security key information for the user.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response message for importing an SSH public key.
"details": "A String", # Detailed information about import results.
"loginProfile": { # The user profile information used for logging in to a virtual machine on Google Compute Engine. # The login profile information for the user.
"name": "A String", # Required. A unique user ID.
"posixAccounts": [ # The list of POSIX accounts associated with the user.
{ # The POSIX account information associated with a Google account.
"accountId": "A String", # Output only. A POSIX account identifier.
"gecos": "A String", # The GECOS (user information) entry for this account.
"gid": "A String", # The default group ID.
"homeDirectory": "A String", # The path to the home directory for this account.
"name": "A String", # Output only. The canonical resource name.
"operatingSystemType": "A String", # The operating system type where this account applies.
"primary": True or False, # Only one POSIX account can be marked as primary.
"shell": "A String", # The path to the logic shell for this account.
"systemId": "A String", # System identifier for which account the username or uid applies to. By default, the empty value is used.
"uid": "A String", # The user ID.
"username": "A String", # The username of the POSIX account.
},
],
"securityKeys": [ # The registered security key credentials for a user.
{ # The credential information for a Google registered security key.
"deviceNickname": "A String", # The security key nickname explicitly set by the user.
"privateKey": "A String", # Hardware-backed private key text in SSH format.
"publicKey": "A String", # Public key text in SSH format, defined by [RFC4253]("https://www.ietf.org/rfc/rfc4253.txt") section 6.6.
"universalTwoFactor": { # Security key information specific to the U2F protocol. # The U2F protocol type.
"appId": "A String", # Application ID for the U2F protocol.
},
"webAuthn": { # Security key information specific to the Web Authentication protocol. # The Web Authentication protocol type.
"rpId": "A String", # Relying party ID for Web Authentication.
},
},
],
"sshPublicKeys": { # A map from SSH public key fingerprint to the associated key object.
"a_key": { # The SSH public key information associated with a Google account.
"expirationTimeUsec": "A String", # An expiration time in microseconds since epoch.
"fingerprint": "A String", # Output only. The SHA-256 fingerprint of the SSH public key.
"key": "A String", # Required. Public key text in SSH format, defined by [RFC4253](https://www.ietf.org/rfc/rfc4253.txt) section 6.6.
"name": "A String", # Output only. The canonical resource name.
},
},
},
}</pre>
</div>
</body></html>
|
