class OvirtSDK4::DomainUsersService

Public Class Methods

new(connection, path) click to toggle source

Creates a new implementation of the service.

@param connection [Connection] The connection to be used by this service.

@param path [String] The relative path of this service, for example `vms/123/disks`.

@api private

# File lib/ovirtsdk4/services.rb, line 7363
def initialize(connection, path)
  @connection = connection
  @path = path
end

Public Instance Methods

list(opts = {}) click to toggle source

List all the users in the domain.

Usage:

.… GET /ovirt-engine/api/domains/5678/users .…

Will return the list of users in the domain:

source,xml

<users>

<user href="/ovirt-engine/api/domains/5678/users/1234" id="1234">
  <name>admin</name>
  <namespace>*</namespace>
  <principal>admin</principal>
  <user_name>admin@internal-authz</user_name>
  <domain href="/ovirt-engine/api/domains/5678" id="5678">
    <name>internal-authz</name>
  </domain>
  <groups/>
</user>

</users>


@param opts [Hash] Additional options.

@option opts [Boolean] :case_sensitive Indicates if the search performed using the `search` parameter should be performed taking case into

account. The default value is `true`, which means that case is taken into account. If you want to search
ignoring case set it to `false`.

@option opts [Integer] :max Sets the maximum number of users to return. If not specified all the users are returned.

@option opts [String] :search A query string used to restrict the returned users.

@return [Array<User>]

# File lib/ovirtsdk4/services.rb, line 7407
def list(opts = {})
  query = {}
  value = opts[:case_sensitive]
  unless value.nil?
    value = Writer.render_boolean(value)
    query['case_sensitive'] = value
  end
  value = opts[:max]
  unless value.nil?
    value = Writer.render_integer(value)
    query['max'] = value
  end
  value = opts[:search]
  unless value.nil?
    query['search'] = value
  end
  request = HttpRequest.new(method: :GET, url: @path, query: query)
  response = @connection.send(request)
  case response.code
  when 200
    begin
      reader = XmlReader.new(response.body)
      return UserReader.read_many(reader)
    ensure
      reader.close
    end
  else
    check_fault(response)
  end
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 7456
def service(path)
  if path.nil? || path == ''
    return self
  end
  index = path.index('/')
  if index.nil?
    return user_service(path)
  end
  return user_service(path[0..(index - 1)]).service(path[(index +1)..-1])
end
to_s() click to toggle source

Returns an string representation of this service.

@return [String]

# File lib/ovirtsdk4/services.rb, line 7472
def to_s
  "#<#{DomainUsersService}:#{@path}>"
end
user_service(id) click to toggle source

Reference to a service to view details of a domain user.

@param id [String] The identifier of the `user`.

@return [DomainUserService] A reference to the `user` service.

# File lib/ovirtsdk4/services.rb, line 7445
def user_service(id)
  DomainUserService.new(@connection, "#{@path}/#{id}")
end