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 28272 def initialize(connection, path) @connection = connection @path = path end
Add user from a directory service.
For example, to add the `myuser` user from the `myextension-authz` authorization provider send a request like this:
POST /ovirt-engine/api/users
With a request body like this:
<user>
<user_name>myuser@myextension-authz</user_name> <domain> <name>myextension-authz</name> </domain>
</user>
In case you are working with Active Directory you have to pass user principal name (UPN) as `username`, followed by authorization provider name. Due to bugzilla.redhat.com/1147900[bug 1147900] you need to provide also `principal` parameter set to UPN of the user.
For example, to add the user with UPN `myuser@mysubdomain.mydomain.com` from the `myextension-authz` authorization provider send a request body like this:
<user>
<principal>myuser@mysubdomain.mydomain.com</principal> <user_name>myuser@mysubdomain.mydomain.com@myextension-authz</user_name> <domain> <name>myextension-authz</name> </domain>
</user>
@param user [User] The `user` to add.
@param opts [Hash] Additional options.
@return [User]
# File lib/ovirtsdk4/services.rb, line 28324 def add(user, opts = {}) if user.is_a?(Hash) user = OvirtSDK4::User.new(user) end query = {} request = HttpRequest.new(method: :POST, url: @path, query: query) begin writer = XmlWriter.new(nil, true) UserWriter.write_one(user, writer) request.body = writer.string ensure writer.close end response = @connection.send(request) case response.code when 200, 201, 202 begin reader = XmlReader.new(response.body) return UserReader.read_one(reader) ensure reader.close end else check_fault(response) end end
List all the users in the system.
Usage:
.… GET /ovirt-engine/api/users .…
Will return the list of users:
<users>
<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"/> <domain_entry_id>23456</domain_entry_id> <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>
</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 28394 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
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 28443 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
Returns an string representation of this service.
@return [String]
# File lib/ovirtsdk4/services.rb, line 28459 def to_s "#<#{UsersService}:#{@path}>" end
Locates the `user` service.
@param id [String] The identifier of the `user`.
@return [UserService] A reference to the `user` service.
# File lib/ovirtsdk4/services.rb, line 28432 def user_service(id) UserService.new(@connection, "#{@path}/#{id}") end