google_api_os_login v0.7.0 GoogleApi.OSLogin.V1.Api.Users View Source
API calls for all endpoints tagged Users.
Link to this section Summary
Functions
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
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.
Deletes a POSIX account.
Retrieves an SSH public key.
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, optional_params \\ [], opts \\ []) View Source
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
Parameters
- connection (GoogleApi.OSLogin.V1.Connection): Connection to server
- name (String.t): The unique ID for the user in format `users/{user}`.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :projectId (String.t): The project ID of the Google Cloud Platform project.
- :systemId (String.t): A system ID for filtering the results of the request.
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.LoginProfile{}} on success {:error, info} on failure
Link to this function
oslogin_users_import_ssh_public_key(connection, parent, optional_params \\ [], opts \\ []) View Source
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.V1.Connection): Connection to server
- parent (String.t): The unique ID for the user in format `users/{user}`.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :projectId (String.t): The project ID of the Google Cloud Platform project.
- :body (SshPublicKey):
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.ImportSshPublicKeyResponse{}} on success {:error, info} on failure
Link to this function
oslogin_users_projects_delete(connection, name, optional_params \\ [], opts \\ []) View Source
Deletes a POSIX account.
Parameters
- connection (GoogleApi.OSLogin.V1.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}`.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.Empty{}} on success {:error, info} on failure
Link to this function
oslogin_users_ssh_public_keys_get(connection, name, optional_params \\ [], opts \\ []) View Source
Retrieves an SSH public key.
Parameters
- connection (GoogleApi.OSLogin.V1.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}`.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.SshPublicKey{}} on success {:error, info} on failure
Link to this function
oslogin_users_ssh_public_keys_patch(connection, name, optional_params \\ [], opts \\ []) View Source
Updates an SSH public key and returns the profile information. This method supports patch semantics.
Parameters
- connection (GoogleApi.OSLogin.V1.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}`.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :updateMask (String.t): Mask to control which fields get updated. Updates all if not present.
- :body (SshPublicKey):
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.SshPublicKey{}} on success {:error, info} on failure