class OvirtSDK4::UsersService
Constants
- ADD
- LIST
Public Instance Methods
Add user from a directory service.
For example, to add the `myuser` user from the `myextension-authz` authorization provider send a request like this:
- source
POST /ovirt-engine/api/users
With a request body like this:
- source,xml
<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 https://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:
- source,xml
<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.
@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 29879 def add(user, opts = {}) internal_add(user, User, ADD, opts) end
List
all the users in the system.
Usage:
.… GET /ovirt-engine/api/users .…
Will return the list of users:
- source,xml
<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>
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 29949 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 29971 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
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 29960 def user_service(id) UserService.new(self, id) end