Cloud OS Login API . users

Instance Methods

projects()

Returns the projects Resource.

sshPublicKeys()

Returns the sshPublicKeys Resource.

close()

Close httplib2 connections.

getLoginProfile(name, projectId=None, systemId=None, x__xgafv=None)

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

importSshPublicKey(parent, body=None, projectId=None, x__xgafv=None)

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.

Method Details

close()
Close httplib2 connections.
getLoginProfile(name, projectId=None, systemId=None, x__xgafv=None)
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)
  projectId: string, The project ID of the Google Cloud Platform project.
  systemId: string, A system ID for filtering the results of the request.
  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.
    "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", # Public key text in SSH format, defined by RFC4253 section 6.6.
        "name": "A String", # Output only. The canonical resource name.
      },
    },
    "posixAccounts": [ # The list of POSIX accounts associated with the user.
      { # The POSIX account information associated with a Google account.
        "homeDirectory": "A String", # The path to the home directory for this account.
        "shell": "A String", # The path to the logic shell for this 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.
        "primary": True or False, # Only one POSIX account can be marked as primary.
        "username": "A String", # The username of the POSIX account.
        "systemId": "A String", # System identifier for which account the username or uid applies to. By default, the empty value is used.
        "name": "A String", # Output only. The canonical resource name.
        "uid": "A String", # The user ID.
        "operatingSystemType": "A String", # The operating system type where this account applies.
      },
    ],
  }
importSshPublicKey(parent, body=None, projectId=None, x__xgafv=None)
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, Required. 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", # Public key text in SSH format, defined by RFC4253 section 6.6.
  "name": "A String", # Output only. The canonical resource name.
}

  projectId: string, The project ID of the Google Cloud Platform project.
  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.
      "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", # Public key text in SSH format, defined by RFC4253 section 6.6.
          "name": "A String", # Output only. The canonical resource name.
        },
      },
      "posixAccounts": [ # The list of POSIX accounts associated with the user.
        { # The POSIX account information associated with a Google account.
          "homeDirectory": "A String", # The path to the home directory for this account.
          "shell": "A String", # The path to the logic shell for this 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.
          "primary": True or False, # Only one POSIX account can be marked as primary.
          "username": "A String", # The username of the POSIX account.
          "systemId": "A String", # System identifier for which account the username or uid applies to. By default, the empty value is used.
          "name": "A String", # Output only. The canonical resource name.
          "uid": "A String", # The user ID.
          "operatingSystemType": "A String", # The operating system type where this account applies.
        },
      ],
    },
  }