org.freedesktop.home1
systemd
org.freedesktop.home1
5
org.freedesktop.home1
The D-Bus interface of systemd-homed
Introduction
systemd-homed.service8
is a system service which may be used to to create, remove, change or inspect home areas. This page
describes the D-Bus interface.
The Manager Object
The service exposes the following interfaces on the Manager object on the bus:
node /org/freedesktop/home1 {
interface org.freedesktop.home1.Manager {
methods:
GetHomeByName(in s user_name,
out u uid,
out s home_state,
out u gid,
out s real_name,
out s home_directory,
out s shell,
out o bus_path);
GetHomeByUID(in u uid,
out s user_name,
out s home_state,
out u gid,
out s real_name,
out s home_directory,
out s shell,
out o bus_path);
GetUserRecordByName(in s user_name,
out s user_record,
out b incomplete,
out o bus_path);
GetUserRecordByUID(in u uid,
out s user_record,
out b incomplete,
out o bus_path);
ListHomes(out a(susussso) home_areas);
ActivateHome(in s user_name,
in s user_record);
DeactivateHome(in s user_name);
RegisterHome(in s home_record);
UnregisterHome(in s user_name);
CreateHome(in s home_record);
RealizeHome(in s user_name,
in s user_record);
RemoveHome(in s user_name);
FixateHome(in s user_name,
in s user_record);
AuthenticateHome(in s user_name,
in s user_record);
UpdateHome(in s user_record);
ResizeHome(in s user_name,
in t size,
in s user_record);
ChangePasswordHome(in s user_name,
in s new_user_record,
in s old_user_record);
LockHome(in s user_name);
UnlockHome(in s user_name,
in s user_record);
AcquireHome(in s user_name,
in s user_record,
in b please_suspend,
out h send_fd);
RefHome(in s user_name,
in b please_suspend,
out h send_fd);
ReleaseHome(in s user_name);
LockAllHomes();
properties:
readonly a(sso) AutoLogin = [...];
};
interface org.freedesktop.DBus.Peer { ... };
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
Methods
...
Signals
...
The Home Object
node /org/freedesktop/home1/home {
interface org.freedesktop.home1.Home {
methods:
Activate(in s user_record);
Deactivate();
Unregister();
Realize(in s user_record);
Remove();
Fixate(in s user_record);
Authenticate(in s user_record);
Update(in s user_record);
Resize(in t size,
in s user_record);
ChangePassword(in s new_user_record,
in s old_user_record);
Lock();
Unlock(in s user_record);
Acquire(in s user_record,
in b please_suspend,
out h send_fd);
Ref(in b please_suspend,
out h send_fd);
Release();
properties:
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
readonly s UserName = '...';
readonly u UID = ...;
readonly (suusss) UnixRecord = ...;
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
readonly s State = '...';
@org.freedesktop.DBus.Property.EmitsChangedSignal("invalidates")
readonly (sb) UserRecord = ...;
};
interface org.freedesktop.DBus.Peer { ... };
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
interface org.freedesktop.DBus.ObjectManager { ... };
};
Versioning
These D-Bus interfaces follow
the usual interface versioning guidelines.