Class: Google::Apis::OsloginV1beta::CloudOSLoginService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/oslogin_v1beta/service.rb

Overview

Cloud OS Login API

Manages OS login configuration for Google account users.

Examples:

require 'google/apis/oslogin_v1beta'

Oslogin = Google::Apis::OsloginV1beta # Alias the module
service = Oslogin::CloudOSLoginService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeCloudOSLoginService


45
46
47
48
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 45

def initialize
  super('https://oslogin.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#delete_user_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsloginV1beta::Empty

Deletes a POSIX account.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


147
148
149
150
151
152
153
154
155
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 147

def delete_user_project(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::OsloginV1beta::Empty::Representation
  command.response_class = Google::Apis::OsloginV1beta::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsloginV1beta::Empty

Deletes an SSH public key.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


179
180
181
182
183
184
185
186
187
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 179

def delete_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::OsloginV1beta::Empty::Representation
  command.response_class = Google::Apis::OsloginV1beta::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_login_profile(name, project_id: nil, system_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsloginV1beta::LoginProfile

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


75
76
77
78
79
80
81
82
83
84
85
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 75

def (name, project_id: nil, system_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta/{+name}/loginProfile', options)
  command.response_representation = Google::Apis::OsloginV1beta::LoginProfile::Representation
  command.response_class = Google::Apis::OsloginV1beta::LoginProfile
  command.params['name'] = name unless name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['systemId'] = system_id unless system_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsloginV1beta::SshPublicKey

Retrieves an SSH public key.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


211
212
213
214
215
216
217
218
219
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 211

def get_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation
  command.response_class = Google::Apis::OsloginV1beta::SshPublicKey
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#import_user_ssh_public_key(parent, ssh_public_key_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


112
113
114
115
116
117
118
119
120
121
122
123
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 112

def import_user_ssh_public_key(parent, ssh_public_key_object = nil, project_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta/{+parent}:importSshPublicKey', options)
  command.request_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation
  command.request_object = ssh_public_key_object
  command.response_representation = Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse::Representation
  command.response_class = Google::Apis::OsloginV1beta::ImportSshPublicKeyResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_ssh_public_key(name, ssh_public_key_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::OsloginV1beta::SshPublicKey

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


247
248
249
250
251
252
253
254
255
256
257
258
# File 'generated/google/apis/oslogin_v1beta/service.rb', line 247

def patch_user_ssh_public_key(name, ssh_public_key_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1beta/{+name}', options)
  command.request_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation
  command.request_object = ssh_public_key_object
  command.response_representation = Google::Apis::OsloginV1beta::SshPublicKey::Representation
  command.response_class = Google::Apis::OsloginV1beta::SshPublicKey
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end