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