google_api_os_login

v0.1.0

google_api_os_login v0.1.0 GoogleApi.OSLogin.V1alpha.Api.Users View Source

API calls for all endpoints tagged Users.

Link to this section Summary

Functions

oslogin_users_get_login_profile(connection, name, 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, 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, opts \\ [])

Deletes a POSIX account

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

Retrieves an SSH public key

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

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

Link to this section Functions

Link to this function oslogin_users_get_login_profile(connection, name, opts \\ []) View Source 
oslogin_users_get_login_profile(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.LoginProfile.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.OSLogin.V1alpha.Connection): Connection to server
  • name (String.t): The unique ID for the user in format `users/{user}`.

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.

Returns

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

Link to this function oslogin_users_import_ssh_public_key(connection, parent, opts \\ []) View Source 
oslogin_users_import_ssh_public_key(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.ImportSshPublicKeyResponse.t()}
  | {:error, Tesla.Env.t()}

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 (GoogleApi.OSLogin.V1alpha.Connection): Connection to server
  • parent (String.t): The unique ID for the user in format `users/{user}`.

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :projectId (String.t): The project ID of the Google Cloud Platform project.
    • :body (SshPublicKey):

Returns

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

Link to this function oslogin_users_projects_delete(connection, name, opts \\ []) View Source 
oslogin_users_projects_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a POSIX account.

Parameters

  • connection (GoogleApi.OSLogin.V1alpha.Connection): Connection to server
  • name (String.t): 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}`.

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :operatingSystemType (String.t): The type of operating system associated with the account.

Returns

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

Link to this function oslogin_users_ssh_public_keys_get(connection, name, opts \\ []) View Source 
oslogin_users_ssh_public_keys_get(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t()}
  | {:error, Tesla.Env.t()}

Retrieves an SSH public key.

Parameters

  • connection (GoogleApi.OSLogin.V1alpha.Connection): Connection to server
  • name (String.t): 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}`.

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.

Returns

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

Link to this function oslogin_users_ssh_public_keys_patch(connection, name, opts \\ []) View Source 
oslogin_users_ssh_public_keys_patch(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.OSLogin.V1alpha.Model.SshPublicKey.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.OSLogin.V1alpha.Connection): Connection to server
  • name (String.t): 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}`.

  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :quotaUser (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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :updateMask (String.t): Mask to control which fields get updated. Updates all if not present.
    • :body (SshPublicKey):

Returns

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