google_api_os_login v0.19.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.
Deletes an SSH public key.
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
oslogin_users_get_login_profile(connection, name, optional_params \\ [], opts \\ [])
View Sourceoslogin_users_get_login_profile( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.OSLogin.V1.Model.LoginProfile.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
Parameters
connection
(type:GoogleApi.OSLogin.V1.Connection.t
) - Connection to servername
(type:String.t
) - Required. The unique ID for the user in formatusers/{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.:systemId
(type:String.t
) - A system ID for filtering the results of the request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.LoginProfile{}}
on success{:error, info}
on failure
oslogin_users_import_ssh_public_key(connection, parent, optional_params \\ [], opts \\ [])
View Sourceoslogin_users_import_ssh_public_key( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.OSLogin.V1.Model.ImportSshPublicKeyResponse.t()} | {:ok, Tesla.Env.t()} | {: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.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The unique ID for the user in formatusers/{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.:body
(type:GoogleApi.OSLogin.V1.Model.SshPublicKey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.ImportSshPublicKeyResponse{}}
on success{:error, info}
on failure
oslogin_users_projects_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceoslogin_users_projects_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.OSLogin.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a POSIX account.
Parameters
connection
(type:GoogleApi.OSLogin.V1.Connection.t
) - Connection to servername
(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 formatusers/{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").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.Empty{}}
on success{:error, info}
on failure
oslogin_users_ssh_public_keys_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourceoslogin_users_ssh_public_keys_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.OSLogin.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes an SSH public key.
Parameters
connection
(type:GoogleApi.OSLogin.V1.Connection.t
) - Connection to servername
(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 formatusers/{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.V1.Model.Empty{}}
on success{:error, info}
on failure
oslogin_users_ssh_public_keys_get(connection, name, optional_params \\ [], opts \\ [])
View Sourceoslogin_users_ssh_public_keys_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.OSLogin.V1.Model.SshPublicKey.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieves an SSH public key.
Parameters
connection
(type:GoogleApi.OSLogin.V1.Connection.t
) - Connection to servername
(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 formatusers/{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.V1.Model.SshPublicKey{}}
on success{:error, info}
on failure
oslogin_users_ssh_public_keys_patch(connection, name, optional_params \\ [], opts \\ [])
View Sourceoslogin_users_ssh_public_keys_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.OSLogin.V1.Model.SshPublicKey.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates an SSH public key and returns the profile information. This method supports patch semantics.
Parameters
connection
(type:GoogleApi.OSLogin.V1.Connection.t
) - Connection to servername
(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 formatusers/{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.V1.Model.SshPublicKey.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.OSLogin.V1.Model.SshPublicKey{}}
on success{:error, info}
on failure