Cloud OS Login API . users

Instance Methods

projects()

Returns the projects Resource.

sshPublicKeys()

Returns the sshPublicKeys Resource.

close()

Close httplib2 connections.

getLoginProfile(name, operatingSystemType=None, projectId=None, systemId=None, view=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, view=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, operatingSystemType=None, projectId=None, systemId=None, view=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)
  operatingSystemType: string, 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, The project ID of the Google Cloud Platform project.
  systemId: string, 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.
      "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", # Public key text in SSH format, defined by RFC4253 section 6.6.
      "name": "A String", # Output only. The canonical resource name.
    },
  },
}
importSshPublicKey(parent, body=None, projectId=None, view=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, 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.
  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.
        "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", # Public key text in SSH format, defined by RFC4253 section 6.6.
        "name": "A String", # Output only. The canonical resource name.
      },
    },
  },
}