Debian Codegraph @

upstream/debian-trixie/man5/org.freedesktop.home1.5

raw
1 '\" t
2 .TH "ORG\&.FREEDESKTOP\&.HOME1" "5" "" "systemd 257.13" "org.freedesktop.home1"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 org.freedesktop.home1 \- The D\-Bus interface of systemd\-homed
24 .SH "INTRODUCTION"
25 .PP
26 \fBsystemd-homed.service\fR(8)
27 is a system service which may be used to create, remove, change or inspect home areas\&. This page describes the D\-Bus interface\&.
28 .SH "THE MANAGER OBJECT"
29 .PP
30 The service exposes the following interfaces on the Manager object on the bus:
31 .sp
32 .if n \{\
33 .RS 4
34 .\}
35 .nf
36 node /org/freedesktop/home1 {
37 interface org\&.freedesktop\&.home1\&.Manager {
38 methods:
39 GetHomeByName(in s user_name,
40 out u uid,
41 out s home_state,
42 out u gid,
43 out s real_name,
44 out s home_directory,
45 out s shell,
46 out o bus_path);
47 GetHomeByUID(in u uid,
48 out s user_name,
49 out s home_state,
50 out u gid,
51 out s real_name,
52 out s home_directory,
53 out s shell,
54 out o bus_path);
55 GetUserRecordByName(in s user_name,
56 out s user_record,
57 out b incomplete,
58 out o bus_path);
59 GetUserRecordByUID(in u uid,
60 out s user_record,
61 out b incomplete,
62 out o bus_path);
63 ListHomes(out a(susussso) home_areas);
64 ActivateHome(in s user_name,
65 in s secret);
66 ActivateHomeIfReferenced(in s user_name,
67 in s secret);
68 @org\&.freedesktop\&.systemd1\&.Privileged("true")
69 DeactivateHome(in s user_name);
70 RegisterHome(in s user_record);
71 UnregisterHome(in s user_name);
72 CreateHome(in s user_record);
73 CreateHomeEx(in s user_record,
74 in a{sh} blobs,
75 in t flags);
76 RealizeHome(in s user_name,
77 in s secret);
78 RemoveHome(in s user_name);
79 @org\&.freedesktop\&.systemd1\&.Privileged("true")
80 FixateHome(in s user_name,
81 in s secret);
82 AuthenticateHome(in s user_name,
83 in s secret);
84 UpdateHome(in s user_record);
85 UpdateHomeEx(in s user_record,
86 in a{sh} blobs,
87 in t flags);
88 ResizeHome(in s user_name,
89 in t size,
90 in s secret);
91 ChangePasswordHome(in s user_name,
92 in s new_secret,
93 in s old_secret);
94 @org\&.freedesktop\&.systemd1\&.Privileged("true")
95 LockHome(in s user_name);
96 @org\&.freedesktop\&.systemd1\&.Privileged("true")
97 UnlockHome(in s user_name,
98 in s secret);
99 AcquireHome(in s user_name,
100 in s secret,
101 in b please_suspend,
102 out h send_fd);
103 @org\&.freedesktop\&.systemd1\&.Privileged("true")
104 RefHome(in s user_name,
105 in b please_suspend,
106 out h send_fd);
107 @org\&.freedesktop\&.systemd1\&.Privileged("true")
108 RefHomeUnrestricted(in s user_name,
109 in b please_suspend,
110 out h send_fd);
111 @org\&.freedesktop\&.systemd1\&.Privileged("true")
112 ReleaseHome(in s user_name);
113 @org\&.freedesktop\&.systemd1\&.Privileged("true")
114 LockAllHomes();
115 @org\&.freedesktop\&.systemd1\&.Privileged("true")
116 DeactivateAllHomes();
117 @org\&.freedesktop\&.systemd1\&.Privileged("true")
118 Rebalance();
119 properties:
120 readonly a(sso) AutoLogin = [\&.\&.\&.];
121 };
122 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
123 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
124 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
125 };
126 .fi
127 .if n \{\
128 .RE
129 .\}
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161 .SS "Methods"
162 .PP
163 \fBGetHomeByName()\fR
164 returns basic user information (a minimal subset of the full user record), provided a user name\&. The information supplied more or less matches what
165 \fBgetpwnam\fR(3)
166 returns: the numeric UID and GID, the real name, home directory and shell\&. In addition it returns a state identifier describing the state the user\*(Aqs home directory is in, as well as a bus path referring to the bus object encapsulating the user record and home directory\&. This object implements the
167 org\&.freedesktop\&.home1\&.Home
168 interface documented below\&. This method, and most others in this interface that take user names, will try to use the caller\*(Aqs home area if the specified user name is an empty string\&.
169 .PP
170 \fBGetHomeByUID()\fR
171 is similar to
172 \fBGetHomeByName()\fR
173 but acquires the information based on the numeric UID of the user\&.
174 .PP
175 \fBGetUserRecordByName()\fR
176 is also similar to
177 \fBGetHomeByName()\fR
178 but returns the full JSON user record data instead of the broken down records\&. An additional returned boolean indicates whether the record is complete or not\&. A record is considered complete when its
179 "privileged"
180 section is included, and incomplete if it was removed (see
181 \m[blue]\fBJSON User Records\fR\m[]\&\s-2\u[1]\d\s+2
182 for details about the various sections of a user record)\&. Generally, only privileged clients and clients running under the identity of the user itself get access to the
183 "privileged"
184 section and will thus see complete records\&.
185 .PP
186 \fBGetUserRecordByUID()\fR
187 is similar to
188 \fBGetUserRecordByName()\fR
189 but returns the user record matching the specified numeric UID\&.
190 .PP
191 \fBListHomes()\fR
192 returns an array of all locally managed users\&. The array contains the same fields
193 \fBGetHomeByName()\fR
194 returns: user name, numeric UID, state, numeric GID, real name, home directory, shell and bus path of the matching bus object\&.
195 .PP
196 \fBActivateHome()\fR
197 activates (i\&.e\&. mounts) the home directory of the specified user\&. The second argument shall contain a user record consisting only of a
198 "secret"
199 section (all other sections should be stripped, see
200 \m[blue]\fBJSON User Records\fR\m[]\&\s-2\u[1]\d\s+2
201 for details), and should contain only the secret credentials necessary for unlocking the home directory\&. Typically a client would invoke this function first with an entirely empty record (which is possibly sufficient if single\-factor authentication with a plugged\-in security token is configured), and would then retry with a record populated with more information, depending on the returned error code, in case more credentials are necessary\&. This function is synchronous and returns only after the home directory was fully activated (or the operation failed), which might take some time\&. Clients must be prepared for that, and typically should extend the D\-Bus method call timeout accordingly\&. This method is equivalent to the
202 \fBActivate()\fR
203 method on the
204 org\&.freedesktop\&.home1\&.Home
205 interface documented below, but may be called on the manager object and takes a user name as additional argument, instead\&.
206 .PP
207 \fBActivateHomeIfReferenced()\fR
208 is identical to
209 \fBActivateHome()\fR\&. However, the call only succeeds if the home directory is currently referenced\&. Useful in conjunction with
210 \fBRefHomeUnrestricted()\fR, which allows creating a reference to a home directory even if the home directory is not active\&.
211 .PP
212 \fBDeactivateHome()\fR
213 deactivates (i\&.e\&. unmounts) the home directory of the specified user\&. It is equivalent to the
214 \fBDeactivate()\fR
215 method on the
216 org\&.freedesktop\&.home1\&.Home
217 interface documented below\&.
218 .PP
219 \fBRegisterHome()\fR
220 registers a new home directory locally\&. It receives the JSON user record as only argument (which typically excludes the
221 "secret"
222 section)\&. Registering a home directory just makes the user record known to the system, it does not create a home directory or such (which is expected to exist already, or created later)\&. This operation is useful to register home directories locally that are not located where
223 systemd\-homed\&.service
224 would find them automatically\&.
225 .PP
226 \fBUnregisterHome()\fR
227 unregisters an existing home directory\&. It takes a user name as argument and undoes what
228 \fBRegisterHome()\fR
229 does\&. It does not attempt to remove the home directory itself, it just unregisters it with the local system\&. Note that if the home directory is placed where
230 systemd\-homed\&.service
231 looks for home directories anyway this call will only undo fixation (see below), but the record will remain known to
232 systemd\-homed\&.service
233 and be listed among known records\&. Since the user record is embedded into the home directory this operation generally does not discard data belonging to the user or their record\&. This method is equivalent to
234 \fBUnregister()\fR
235 on the
236 org\&.freedesktop\&.home1\&.Home
237 interface\&.
238 .PP
239 \fBCreateHome()\fR
240 registers and creates a new home directory\&. This takes a fully specified JSON user record as argument (including the
241 "secret"
242 section)\&. This registers the user record locally and creates a home directory matching it, depending on the settings specified in the record in combination with local configuration\&.
243 .PP
244 \fBCreateHomeEx()\fR
245 is like
246 \fBCreateHome()\fR, but it allows the home directory to be created with a pre\-populated blob directory (see
247 \m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[2]\d\s+2
248 for more info)\&. This can be done via the dictionary passed as the
249 \fIblobs\fR
250 argument to this method: the values are open file descriptors to regular files, and the keys are the filenames that should contain their respective file\*(Aqs data in the blob directory\&. Note that for security reasons, the file descriptors passed into this method must have enough privileges to read their target file and thus cannot be
251 "O_PATH"; this is done to ensure the caller is actually permitted to read the file they are asking to publish in the blob directories\&. If the user record passed as the first argument contains a
252 "blobManifest"
253 field it will be enforced; otherwise, a
254 "blobManifest"
255 field will be generated and inserted into the record\&. The
256 \fIflags\fR
257 argument may be used for future expansion, but for now pass 0\&.
258 .PP
259 \fBRealizeHome()\fR
260 creates a home directory whose user record is already registered locally\&. This takes a user name plus a user record consisting only of the
261 "secret"
262 section\&. Invoking
263 \fBRegisterHome()\fR
264 followed by
265 \fBRealizeHome()\fR
266 is mostly equivalent to calling
267 \fBCreateHome()\fR, except that the latter combines the two in atomic fashion\&. This method is equivalent to
268 \fBRealize()\fR
269 on the
270 org\&.freedesktop\&.home1\&.Home
271 interface\&.
272 .PP
273 \fBRemoveHome()\fR
274 unregisters a user record locally, and removes the home directory belonging to it, if it is accessible\&. It takes a user name as argument\&. This method is equivalent to
275 \fBRemove()\fR
276 on the
277 org\&.freedesktop\&.home1\&.Home
278 interface\&.
279 .PP
280 \fBFixateHome()\fR
281 "fixates"
282 an automatically discovered home directory\&.
283 systemd\-homed\&.service
284 automatically discovers home directories dropped in our plugged in and adds them to the runtime list of user records it manages\&. A user record discovered that way may be
285 "fixated", in which case it is copied out of the home directory, onto persistent storage, to fixate the UID/GID assignment of the record, and extract additional (typically previously encrypted) user record data from the home directory\&. A home directory mus be fixated before it can be logged into\&. This method call takes a user name and a JSON user record consisting only of the
286 "secret"
287 section as argument\&. This method is equivalent to
288 \fBFixate()\fR
289 on the
290 org\&.freedesktop\&.home1\&.Home
291 interface\&.
292 .PP
293 \fBAuthenticateHome()\fR
294 checks passwords or other authentication credentials associated with the home directory\&. It takes a user name and a JSON user record consisting only of the
295 "secret"
296 section as argument\&. Note that many of the other method calls authenticate the user first, in order to execute some other operation\&. This method call only authenticates and executes no further operation\&. Like
297 \fBActivateHome()\fR
298 it is usually first invoked with an empty JSON user record, which is then populated for subsequent tries with additional authentication data supplied\&. This method is equivalent to
299 \fBAuthenticate()\fR
300 on the
301 org\&.freedesktop\&.home1\&.Home
302 interface\&.
303 .PP
304 \fBUpdateHome()\fR
305 updates a locally registered user record\&. Takes a fully specified JSON user record as argument (possibly including the
306 "secret"
307 section)\&. A user with a matching name and realm must be registered locally already, and the last change timestamp of the newly supplied record must be newer than the previously existing user record\&. Note this operation updates the user record only, it does not propagate passwords/authentication tokens from the user record to the storage back\-end, or resizes the storage back\-end\&. Typically a home directory is first updated, and then the password of the underlying storage updated using
308 \fBChangePasswordHome()\fR
309 as well as the storage resized using
310 \fBResizeHome()\fR\&. This method is equivalent to
311 \fBUpdate()\fR
312 on the
313 org\&.freedesktop\&.home1\&.Home
314 interface\&.
315 .PP
316 \fBUpdateHomeEx()\fR
317 is like
318 \fBUpdateHome()\fR, but it allows for changes to the blob directory (see
319 \m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[2]\d\s+2
320 for more info)\&. The
321 \fIblobs\fR
322 argument works in the same way as
323 \fBCreateHomeEx()\fR, so check there for details\&. The new blob directory contents passed into this method will completely replace the user\*(Aqs existing blob directory\&. The
324 \fIflags\fR
325 argument can be used to further customize the behavior of this method via flags defined as follows:
326 .sp
327 .if n \{\
328 .RS 4
329 .\}
330 .nf
331 #define SD_HOMED_UPDATE_OFFLINE (UINT64_C(1) << 0)
332 .fi
333 .if n \{\
334 .RE
335 .\}
336 .PP
337 When
338 \fBSD_HOMED_UPDATE_OFFLINE\fR
339 (0x01) is set, no attempt is made to update the copies of the user record and blob directory that are embedded into the home directory\&. Changes will be stored, however, and may be propagated into the home directory the next time it is reconciled (most likely when the user next logs in)\&. Note that any changes made with this flag set may be lost if the home area has a newer record, which can happen if the home area is updated on another machine after this method call\&. This method is equivalent to
340 \fBUpdateEx()\fR
341 on the
342 org\&.freedesktop\&.home1\&.Home
343 interface\&.
344 .PP
345 \fBResizeHome()\fR
346 resizes the storage associated with a user record\&. Takes a user name, a disk size in bytes, and optionally a user record consisting only of the
347 "secret"
348 section as arguments\&. If the size is specified as
349 \fBUINT64_MAX\fR
350 the storage is resized to the size already specified in the user record\&. Typically, if the user record is updated using
351 \fBUpdateHome()\fR
352 above this is used to propagate the size configured there\-in down to the underlying storage back\-end\&. This method is equivalent to
353 \fBResize()\fR
354 on the
355 org\&.freedesktop\&.home1\&.Home
356 interface\&.
357 .PP
358 \fBChangePasswordHome()\fR
359 changes the passwords/authentication tokens of a home directory\&. Takes a user name, and two JSON user record objects, each consisting only of the
360 "secret"
361 section, for the old and for the new passwords/authentication tokens\&. If the user record with the new passwords/authentication token data is specified as empty the existing user record\*(Aqs settings are propagated down to the home directory storage\&. This is typically used after a user record is updated using
362 \fBUpdateHome()\fR
363 in order to propagate the secrets/authentication tokens down to the storage\&. Background: depending on the backend the user\*(Aqs authentication credentials are stored at multiple places: the user record kept on the host, the user record kept in the home directory and the encrypted LUKS volume slot\&. If the home directory is used on a different machined temporarily, and the password is changed there, and then is moved back to the original host, the passwords of the three might get out of sync\&. By issuing
364 \fBChangePasswordHome()\fR
365 the three locations are updated to match the newest information\&. This method is equivalent to
366 \fBChangePassword()\fR
367 on the
368 org\&.freedesktop\&.home1\&.Home
369 interface\&.
370 .PP
371 \fBLockHome()\fR
372 temporarily suspends access to a home directory, flushing out any cryptographic keys from memory\&. This is only supported on some back\-ends, and is usually done during system suspend, in order to effectively secure home directories while the system is sleeping\&. Takes a user name as single argument\&. If an application attempts to access a home directory while it is locked it will typically freeze until the home directory is unlocked again\&. This method is equivalent to
373 \fBLock()\fR
374 on the
375 org\&.freedesktop\&.home1\&.Home
376 interface\&.
377 .PP
378 \fBUnlockHome()\fR
379 undoes the effect of
380 \fBLockHome()\fR\&. Takes a user name and a user record consisting only of the
381 "secret"
382 section as arguments\&. This method is equivalent to
383 \fBUnlock()\fR
384 on the
385 org\&.freedesktop\&.home1\&.Home
386 interface\&.
387 .PP
388 \fBAcquireHome()\fR
389 activates or unlocks a home directory in a reference counted mode of operation\&. Takes a user name and user record consisting only of
390 "secret"
391 section as argument\&. If the home directory is not active yet, it is activated\&. If it is currently locked it is unlocked\&. After completion a reference to the activation/unlocking of the home directory is returned via a file descriptor\&. When the last client which acquired such a file descriptor closes it the home directory is automatically deactivated again\&. This method is typically invoked when a user logs in, and the file descriptor is held until the user logs out again, thus ensuring the user\*(Aqs home directory can be unmounted automatically again in a robust fashion, when the user logs out\&. The third argument is a boolean which indicates whether the client invoking the call is able to automatically re\-authenticate when the system comes back from suspending\&. It should be set by all clients that implement a secure lock screen running outside of the user\*(Aqs context, that is brought up when the system comes back from suspend and can be used to re\-acquire the credentials to unlock the user\*(Aqs home directory\&. If a home directory has at least one client with an open reference to the home directory that does not support this it is not suspended automatically at system suspend, otherwise it is\&. This method is equivalent to
392 \fBAcquire()\fR
393 on the
394 org\&.freedesktop\&.home1\&.Home
395 interface\&.
396 .PP
397 \fBRefHome()\fR
398 is similar to
399 \fBAcquireHome()\fR
400 but takes no user record with
401 "secret"
402 section, i\&.e\&. will take an additional reference to an already activated/unlocked home directory without attempting to activate/unlock it itself\&. It will fail if the home directory is not already activated\&. This method is equivalent to
403 \fBRef()\fR
404 on the
405 org\&.freedesktop\&.home1\&.Home
406 interface\&.
407 .PP
408 \fBRefHomeUnrestricted()\fR
409 is identical to
410 \fBRefHome()\fR
411 but succeeds even if the home area is not active currently\&. This is useful on conjunction with
412 \fBActivateHomeIfReferenced()\fR\&.
413 .PP
414 \fBReleaseHome()\fR
415 releases a home directory again, if all file descriptors referencing it are already closed, that where acquired through
416 \fBAcquireHome()\fR
417 or
418 \fBRefHome()\fR\&. Note that this call does not actually cause the deactivation of the home directory (which happens automatically when the last referencing file descriptor is closed), but is simply a synchronization mechanism that allows delaying of the user session\*(Aqs termination until any triggered deactivation is completed\&. This method is equivalent to
419 \fBRelease()\fR
420 on the
421 org\&.freedesktop\&.home1\&.Home
422 interface\&.
423 .PP
424 \fBLockAllHomes()\fR
425 locks all active home directories that only have references that opted into automatic suspending during system suspend\&. This is usually invoked automatically shortly before system suspend\&.
426 .PP
427 \fBDeactivateAllHomes()\fR
428 deactivates all home areas that are currently active\&. This is usually invoked automatically shortly before system shutdown\&.
429 .PP
430 \fBRebalance()\fR
431 synchronously rebalances free disk space between home areas\&. This only executes an operation if at least one home area using the LUKS2 backend is active and has rebalancing enabled, and is otherwise a NOP\&.
432 .SS "Properties"
433 .PP
434 \fIAutoLogin\fR
435 exposes an array of structures consisting of user name, seat name and object path of an home directory object\&. All locally managed users that have the
436 "autoLogin"
437 field set are listed here, with the seat name they are associated with\&. A display manager may watch this property and pre\-fill the login screen with the users exposed this way\&.
438 .SH "THE HOME OBJECT"
439 .sp
440 .if n \{\
441 .RS 4
442 .\}
443 .nf
444 node /org/freedesktop/home1/home {
445 interface org\&.freedesktop\&.home1\&.Home {
446 methods:
447 Activate(in s secret);
448 ActivateIfReferenced(in s secret);
449 @org\&.freedesktop\&.systemd1\&.Privileged("true")
450 Deactivate();
451 Unregister();
452 Realize(in s secret);
453 Remove();
454 @org\&.freedesktop\&.systemd1\&.Privileged("true")
455 Fixate(in s secret);
456 Authenticate(in s secret);
457 Update(in s user_record);
458 UpdateEx(in s user_record,
459 in a{sh} blobs,
460 in t flags);
461 Resize(in t size,
462 in s secret);
463 ChangePassword(in s new_secret,
464 in s old_secret);
465 @org\&.freedesktop\&.systemd1\&.Privileged("true")
466 Lock();
467 @org\&.freedesktop\&.systemd1\&.Privileged("true")
468 Unlock(in s secret);
469 @org\&.freedesktop\&.systemd1\&.Privileged("true")
470 Acquire(in s secret,
471 in b please_suspend,
472 out h send_fd);
473 @org\&.freedesktop\&.systemd1\&.Privileged("true")
474 Ref(in b please_suspend,
475 out h send_fd);
476 @org\&.freedesktop\&.systemd1\&.Privileged("true")
477 RefUnrestricted(in b please_suspend,
478 out h send_fd);
479 @org\&.freedesktop\&.systemd1\&.Privileged("true")
480 Release();
481 properties:
482 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
483 readonly s UserName = \*(Aq\&.\&.\&.\*(Aq;
484 readonly u UID = \&.\&.\&.;
485 readonly (suusss) UnixRecord = \&.\&.\&.;
486 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
487 readonly s State = \*(Aq\&.\&.\&.\*(Aq;
488 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("invalidates")
489 readonly (sb) UserRecord = \&.\&.\&.;
490 };
491 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
492 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
493 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
494 interface org\&.freedesktop\&.DBus\&.ObjectManager { \&.\&.\&. };
495 };
496 .fi
497 .if n \{\
498 .RE
499 .\}
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526 .SS "Methods"
527 .PP
528 \fBActivate()\fR,
529 \fBActivateIfReferenced()\fR,
530 \fBDeactivate()\fR,
531 \fBUnregister()\fR,
532 \fBRealize()\fR,
533 \fBRemove()\fR,
534 \fBFixate()\fR,
535 \fBAuthenticate()\fR,
536 \fBUpdate()\fR,
537 \fBUpdateEx()\fR,
538 \fBResize()\fR,
539 \fBChangePassword()\fR,
540 \fBLock()\fR,
541 \fBUnlock()\fR,
542 \fBAcquire()\fR,
543 \fBRef()\fR,
544 \fBRefUnrestricted()\fR,
545 \fBRelease()\fR, operate like their matching counterparts on the
546 org\&.freedesktop\&.home1\&.Manager
547 interface (see above)\&. The main difference is that they are methods of the home directory objects, and hence carry no additional user name parameter\&. Which of the two flavors of methods to call depends on the handles to the user known on the client side: if only the user name is known, it is preferable to use the methods on the manager object since they operate with user names only\&. Clients can also easily operate on their own home area by using the methods on the manager object with an empty string as the user name\&. If the client has the home\*(Aqs object path already acquired in some way, however, it is preferable to operate on the
548 org\&.freedesktop\&.home1\&.Home
549 objects instead\&.
550 .SS "Properties"
551 .PP
552 \fIUserName\fR
553 contains the user name of the user account/home directory\&.
554 .PP
555 \fIUID\fR
556 contains the numeric UNIX UID of the user account\&.
557 .PP
558 \fIUnixRecord\fR
559 contains a structure encapsulating the six fields a
560 struct passwd
561 typically contains (the password field is suppressed)\&.
562 .PP
563 \fIState\fR
564 exposes the current state home the home directory\&.
565 .PP
566 \fIUserRecord\fR
567 contains the full JSON user record string of the user account\&.
568 .SH "VERSIONING"
569 .PP
570 These D\-Bus interfaces follow
571 \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[3]\d\s+2\&.
572 .SH "HISTORY"
573 .SS "The Manager Object"
574 .PP
575 \fBActivateHomeIfReferenced()\fR,
576 \fBRefHomeUnrestricted()\fR,
577 \fBCreateHomeEx()\fR, and
578 \fBUpdateHomeEx()\fR
579 were added in version 256\&.
580 .SS "Home Objects"
581 .PP
582 \fBActivateIfReferenced()\fR,
583 \fBRefUnrestricted()\fR, and
584 \fBUpdateEx()\fR
585 were added in version 256\&.
586 .SH "SEE ALSO"
587 .PP
588 \fBsystemd\fR(1), \fBsystemd-homed.service\fR(8), \fBhomectl\fR(1)
589 .SH "NOTES"
590 .IP " 1." 4
591 JSON User Records
592 .RS 4
593 \%https://systemd.io/USER_RECORD
594 .RE
595 .IP " 2." 4
596 User Record Blob Directories
597 .RS 4
598 \%https://systemd.io/USER_RECORD_BLOB_DIRS
599 .RE
600 .IP " 3." 4
601 the usual interface versioning guidelines
602 .RS 4
603 \%https://0pointer.de/blog/projects/versioning-dbus.html
604 .RE