Class: OvirtSDK4::UsersService
- Defined in:
- lib/ovirtsdk4/services.rb,
lib/ovirtsdk4/services.rb
Instance Method Summary collapse
-
#add(user, opts = {}) ⇒ User
Add user from a directory service.
-
#list(opts = {}) ⇒ Array<User>
List all the users in the system.
-
#service(path) ⇒ Service
Locates the service corresponding to the given path.
-
#user_service(id) ⇒ UserService
Locates the
user
service.
Methods inherited from Service
Instance Method Details
#add(user, opts = {}) ⇒ User
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 bug 1147900 you need to provide
also principal
parameter set to UPN of the user.
For example, to add the user with UPN [email protected]
from the myextension-authz
authorization provider send a request body like this:
<user>
<principal>[email protected]</principal>
<user_name>[email protected]@myextension-authz</user_name>
<domain>
<name>myextension-authz</name>
</domain>
</user>
29879 29880 29881 |
# File 'lib/ovirtsdk4/services.rb', line 29879 def add(user, opts = {}) internal_add(user, User, ADD, opts) end |
#list(opts = {}) ⇒ Array<User>
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>
The order of the returned list of users isn’t guaranteed.
29949 29950 29951 |
# File 'lib/ovirtsdk4/services.rb', line 29949 def list(opts = {}) internal_get(LIST, opts) end |
#service(path) ⇒ Service
Locates the service corresponding to the given path.
29971 29972 29973 29974 29975 29976 29977 29978 29979 29980 |
# 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 |
#user_service(id) ⇒ UserService
Locates the user
service.
29960 29961 29962 |
# File 'lib/ovirtsdk4/services.rb', line 29960 def user_service(id) UserService.new(self, id) end |