Class: Google::Apis::OsloginV1::CloudOSLoginService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/oslogin_v1/service.rb

Overview

Cloud OS Login API

You can use OS Login to manage access to your VM instances using IAM roles.

Examples:

require 'google/apis/oslogin_v1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudOSLoginService

Returns a new instance of CloudOSLoginService.



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

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

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



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

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



43
44
45
 
# File 'generated/google/apis/oslogin_v1/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::OsloginV1::Empty

Deletes a POSIX account.

Parameters:

  • name (String) —

    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``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def delete_user_project(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::OsloginV1::Empty::Representation
  command.response_class = Google::Apis::OsloginV1::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::OsloginV1::Empty

Deletes an SSH public key.

Parameters:

  • name (String) —

    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``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def delete_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::OsloginV1::Empty::Representation
  command.response_class = Google::Apis::OsloginV1::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::OsloginV1::LoginProfile

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

Parameters:

  • name (String) —

    Required. The unique ID for the user in format users/user``.

  • project_id (String) (defaults to: nil) —

    The project ID of the Google Cloud Platform project.

  • system_id (String) (defaults to: nil) —

    A system ID for filtering the results of the request.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
84
85
 
# File 'generated/google/apis/oslogin_v1/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, 'v1/{+name}/loginProfile', options)
  command.response_representation = Google::Apis::OsloginV1::LoginProfile::Representation
  command.response_class = Google::Apis::OsloginV1::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::OsloginV1::SshPublicKey

Retrieves an SSH public key.

Parameters:

  • name (String) —

    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``.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

def get_user_ssh_public_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::OsloginV1::SshPublicKey::Representation
  command.response_class = Google::Apis::OsloginV1::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::OsloginV1::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.

Parameters:

  • parent (String) —

    Required. The unique ID for the user in format users/user``.

  • ssh_public_key_object (Google::Apis::OsloginV1::SshPublicKey) (defaults to: nil)
  • project_id (String) (defaults to: nil) —

    The project ID of the Google Cloud Platform project.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'generated/google/apis/oslogin_v1/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, 'v1/{+parent}:importSshPublicKey', options)
  command.request_representation = Google::Apis::OsloginV1::SshPublicKey::Representation
  command.request_object = ssh_public_key_object
  command.response_representation = Google::Apis::OsloginV1::ImportSshPublicKeyResponse::Representation
  command.response_class = Google::Apis::OsloginV1::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::OsloginV1::SshPublicKey

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

Parameters:

  • name (String) —

    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``.

  • ssh_public_key_object (Google::Apis::OsloginV1::SshPublicKey) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Mask to control which fields get updated. Updates all if not present.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'generated/google/apis/oslogin_v1/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, 'v1/{+name}', options)
  command.request_representation = Google::Apis::OsloginV1::SshPublicKey::Representation
  command.request_object = ssh_public_key_object
  command.response_representation = Google::Apis::OsloginV1::SshPublicKey::Representation
  command.response_class = Google::Apis::OsloginV1::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