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