class OvirtSDK4::DomainUsersService
Constants
- LIST
Public Instance Methods
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>
The order of the returned list of users isn't guaranteed.
@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 [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 [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.
@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 [Array<User>]
# File lib/ovirtsdk4/services.rb, line 8479 def list(opts = {}) internal_get(LIST, opts) 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 8501 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
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 8490 def user_service(id) DomainUserService.new(self, id) end