class OvirtSDK4::UserService

Constants

GET
REMOVE
UPDATE

Public Instance Methods

event_subscriptions_service() click to toggle source

List of event-subscriptions for this user.

@return [EventSubscriptionsService] A reference to `event_subscriptions` service.

# File lib/ovirtsdk4/services.rb, line 29487
def event_subscriptions_service
  @event_subscriptions_service ||= EventSubscriptionsService.new(self, 'eventsubscriptions')
end
get(opts = {}) click to toggle source

Gets the system user information.

Usage:

.… GET /ovirt-engine/api/users/1234 .…

Will return the user information:

source,xml

<user href=“/ovirt-engine/api/users/1234” id=“1234”>

<name>admin</name>
<link href="/ovirt-engine/api/users/1234/sshpublickeys" rel="sshpublickeys"/>
<link href="/ovirt-engine/api/users/1234/roles" rel="roles"/>
<link href="/ovirt-engine/api/users/1234/permissions" rel="permissions"/>
<link href="/ovirt-engine/api/users/1234/tags" rel="tags"/>
<department></department>
<domain_entry_id>23456</domain_entry_id>
<email>user1@domain.com</email>
<last_name>Lastname</last_name>
<namespace>*</namespace>
<principal>user1</principal>
<user_name>user1@domain-authz</user_name>
<domain href="/ovirt-engine/api/domains/45678" id="45678">
  <name>domain-authz</name>
</domain>

</user>


@param opts [Hash] Additional options.

@option opts [String] :follow Indicates which inner links should be followed. The objects referenced by these links will be fetched as part

of the current request. See <<documents/003_common_concepts/follow, here>> for details.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [User]

# File lib/ovirtsdk4/services.rb, line 29394
def get(opts = {})
  internal_get(GET, opts)
end
groups_service() click to toggle source

Locates the `groups` service.

@return [DomainUserGroupsService] A reference to `groups` service.

# File lib/ovirtsdk4/services.rb, line 29496
def groups_service
  @groups_service ||= DomainUserGroupsService.new(self, 'groups')
end
options_service() click to toggle source

Locates the `options` service.

@return [UserOptionsService] A reference to `options` service.

# File lib/ovirtsdk4/services.rb, line 29505
def options_service
  @options_service ||= UserOptionsService.new(self, 'options')
end
permissions_service() click to toggle source

Locates the `permissions` service.

@return [AssignedPermissionsService] A reference to `permissions` service.

# File lib/ovirtsdk4/services.rb, line 29514
def permissions_service
  @permissions_service ||= AssignedPermissionsService.new(self, 'permissions')
end
remove(opts = {}) click to toggle source

Removes the system user.

Usage:

.… DELETE /ovirt-engine/api/users/1234 .…

@param opts [Hash] Additional options.

@option opts [Boolean] :async Indicates if the remove should be performed asynchronously. @option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

# File lib/ovirtsdk4/services.rb, line 29425
def remove(opts = {})
  internal_remove(REMOVE, opts)
end
roles_service() click to toggle source

Locates the `roles` service.

@return [AssignedRolesService] A reference to `roles` service.

# File lib/ovirtsdk4/services.rb, line 29523
def roles_service
  @roles_service ||= AssignedRolesService.new(self, 'roles')
end
service(path) click to toggle source

Locates the service corresponding to the given path.

@param path [String] The path of the service.

@return [Service] A reference to the service.

# File lib/ovirtsdk4/services.rb, line 29552
def service(path)
  if path.nil? || path == ''
    return self
  end
  if path == 'eventsubscriptions'
    return event_subscriptions_service
  end
  if path.start_with?('eventsubscriptions/')
    return event_subscriptions_service.service(path[19..-1])
  end
  if path == 'groups'
    return groups_service
  end
  if path.start_with?('groups/')
    return groups_service.service(path[7..-1])
  end
  if path == 'options'
    return options_service
  end
  if path.start_with?('options/')
    return options_service.service(path[8..-1])
  end
  if path == 'permissions'
    return permissions_service
  end
  if path.start_with?('permissions/')
    return permissions_service.service(path[12..-1])
  end
  if path == 'roles'
    return roles_service
  end
  if path.start_with?('roles/')
    return roles_service.service(path[6..-1])
  end
  if path == 'sshpublickeys'
    return ssh_public_keys_service
  end
  if path.start_with?('sshpublickeys/')
    return ssh_public_keys_service.service(path[14..-1])
  end
  if path == 'tags'
    return tags_service
  end
  if path.start_with?('tags/')
    return tags_service.service(path[5..-1])
  end
  raise Error.new("The path \"#{path}\" doesn't correspond to any service")
end
ssh_public_keys_service() click to toggle source

Locates the `ssh_public_keys` service.

@return [SshPublicKeysService] A reference to `ssh_public_keys` service.

# File lib/ovirtsdk4/services.rb, line 29532
def ssh_public_keys_service
  @ssh_public_keys_service ||= SshPublicKeysService.new(self, 'sshpublickeys')
end
tags_service() click to toggle source

Locates the `tags` service.

@return [AssignedTagsService] A reference to `tags` service.

# File lib/ovirtsdk4/services.rb, line 29541
def tags_service
  @tags_service ||= AssignedTagsService.new(self, 'tags')
end
update(user, opts = {}) click to toggle source

Updates information about the user.

Only the `user_options` field can be updated.

For example, to update user options:

source

PUT /ovirt-engine/api/users/123


With a request body like this:

source,xml

<user>

<user_options>
   <property>
      <name>test</name>
      <value>["any","JSON"]</value>
   </property>
</user_options>

</user>


IMPORTANT: Since version 4.4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. Please use the xref:services-user_option endpoint instead.

@param user [User] The `user` to update. @param opts [Hash] Additional options.

@option opts [Hash] :headers ({}) Additional HTTP headers.

@option opts [Hash] :query ({}) Additional URL query parameters.

@option opts [Integer] :timeout (nil) The timeout for this request, in seconds. If no value is explicitly

given then the timeout set globally for the connection will be used.

@option opts [Boolean] :wait (true) If `true` wait for the response.

@return [User]

# File lib/ovirtsdk4/services.rb, line 29478
def update(user, opts = {})
  internal_update(user, User, UPDATE, opts)
end