GoogleApi.OSLogin.V1alpha.Api.Users (google_api_os_login v0.30.0)

View Source

API calls for all endpoints tagged Users.

Summary

Functions

oslogin_users_get_login_profile(connection, name, optional_params \\ [], opts \\ [])

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

oslogin_users_import_ssh_public_key(connection, parent, optional_params \\ [], opts \\ [])

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.

oslogin_users_projects_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a POSIX account.

oslogin_users_projects_locations_sign_ssh_public_key(connection, parent, optional_params \\ [], opts \\ [])

Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.

oslogin_users_projects_provision_posix_account(connection, name, optional_params \\ [], opts \\ [])

Create a POSIX account if it doesn't exist.

oslogin_users_projects_zones_sign_ssh_public_key(connection, parent, optional_params \\ [], opts \\ [])

Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.

oslogin_users_ssh_public_keys_create(connection, parent, optional_params \\ [], opts \\ [])

Create an SSH public key

oslogin_users_ssh_public_keys_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes an SSH public key.

oslogin_users_ssh_public_keys_get(connection, name, optional_params \\ [], opts \\ [])

Retrieves an SSH public key.

oslogin_users_ssh_public_keys_patch(connection, name, optional_params \\ [], opts \\ [])

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Functions

oslogin_users_get_login_profile(connection, name, optional_params \\ [], opts \\ [])

@spec oslogin_users_get_login_profile(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.LoginProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique ID for the user in format users/{user}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :operatingSystemType (type: String.t) - The type of operating system associated with the account.
    • :projectId (type: String.t) - The project ID of the Google Cloud Platform project.
    • :systemId (type: String.t) - A system ID for filtering the results of the request.
    • :view (type: String.t) - The view configures whether to retrieve security keys information.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.LoginProfile{}} on success
  • {:error, info} on failure

oslogin_users_import_ssh_public_key(connection, parent, optional_params \\ [], opts \\ [])

@spec oslogin_users_import_ssh_public_key(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.ImportSshPublicKeyResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - The unique ID for the user in format users/{user}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :projectId (type: String.t) - The project ID of the Google Cloud Platform project.
    • :regions (type: list(String.t)) - 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.
    • :view (type: String.t) - The view configures whether to retrieve security keys information.
    • :body (type: GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.ImportSshPublicKeyResponse{}} on success
  • {:error, info} on failure

oslogin_users_projects_delete(connection, name, optional_params \\ [], opts \\ [])

@spec oslogin_users_projects_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a POSIX account.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format users/{user}/projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :operatingSystemType (type: String.t) - The type of operating system associated with the account.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.Empty{}} on success
  • {:error, info} on failure

oslogin_users_projects_locations_sign_ssh_public_key(connection, parent, optional_params \\ [], opts \\ [])

@spec oslogin_users_projects_locations_sign_ssh_public_key(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.SignSshPublicKeyResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - The parent project and region for the signing request.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSLogin.V1alpha.Model.SignSshPublicKeyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.SignSshPublicKeyResponse{}} on success
  • {:error, info} on failure

oslogin_users_projects_provision_posix_account(connection, name, optional_params \\ [], opts \\ [])

@spec oslogin_users_projects_provision_posix_account(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.PosixAccount.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a POSIX account if it doesn't exist.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The unique ID for the user in format users/{user}/projects/{project}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSLogin.V1alpha.Model.ProvisionPosixAccountRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.PosixAccount{}} on success
  • {:error, info} on failure

oslogin_users_projects_zones_sign_ssh_public_key(connection, parent, optional_params \\ [], opts \\ [])

@spec oslogin_users_projects_zones_sign_ssh_public_key(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.SignSshPublicKeyResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - The parent project and region for the signing request.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSLogin.V1alpha.Model.SignSshPublicKeyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.SignSshPublicKeyResponse{}} on success
  • {:error, info} on failure

oslogin_users_ssh_public_keys_create(connection, parent, optional_params \\ [], opts \\ [])

@spec oslogin_users_ssh_public_keys_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create an SSH public key

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The unique ID for the user in format users/{user}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.SshPublicKey{}} on success
  • {:error, info} on failure

oslogin_users_ssh_public_keys_delete(connection, name, optional_params \\ [], opts \\ [])

@spec oslogin_users_ssh_public_keys_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an SSH public key.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format users/{user}/sshPublicKeys/{fingerprint}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.Empty{}} on success
  • {:error, info} on failure

oslogin_users_ssh_public_keys_get(connection, name, optional_params \\ [], opts \\ [])

@spec oslogin_users_ssh_public_keys_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves an SSH public key.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format users/{user}/sshPublicKeys/{fingerprint}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.SshPublicKey{}} on success
  • {:error, info} on failure

oslogin_users_ssh_public_keys_patch(connection, name, optional_params \\ [], opts \\ [])

@spec oslogin_users_ssh_public_keys_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.OSLogin.V1alpha.Connection.t) - Connection to server
  • name (type: String.t) - Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format users/{user}/sshPublicKeys/{fingerprint}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Mask to control which fields get updated. Updates all if not present.
    • :body (type: GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OSLogin.V1alpha.Model.SshPublicKey{}} on success
  • {:error, info} on failure