ListCachedUsers ()

ListCachedUsers (out 'ao' users)

Lists users which have logged into the system locally before. This is not meant to return an exhaustive list of all users. It is possible for FindUserByName() to return a user that's not on the list.

FindUserById ()

FindUserById (in  'x' id,
              out 'o' user)

Finds a user by uid.

FindUserByName ()

FindUserByName (in  's' name,
                out 'o' user)

Finds a user by its username.

CreateUser ()

CreateUser (in  's' name,
            in  's' fullname,
            out 'o' user,
            in  'i' accountType)

Creates a new user account.

The accountType argument can take the following values:

CacheUser ()

CacheUser (in  's' name,
           out 'o' user)

Caches a user account, so that it shows up in ListCachedUsers() output. The user name may be a remote user, but the system must be able to lookup the user name and resolve the user information.

UncacheUser ()

UncacheUser (in  's' name)

Releases all metadata about a user account, including icon, language and session. If the user account is from a remote server and the user has never logged in before, then that account will no longer show up in ListCachedUsers() output.

DeleteUser ()

DeleteUser (in  'x' id,
            in  'b' removeFiles)

Deletes a user account.

The UserAdded signal

UserAdded ('o' user)

Emitted when a user is added.

The UserDeleted signal

UserDeleted ('o' user)

Emitted when a user is deleted.

The "DaemonVersion" property

'DaemonVersion'  read      's'

The version of the running daemon.

The "HasNoUsers" property

'HasNoUsers'  read      'b'

Whether or not the system has no users

The "HasMultipleUsers" property

'HasMultipleUsers'  read      'b'

Whether or not the system has multiple users

The "AutomaticLoginUsers" property

'AutomaticLoginUsers'  read      'ao'

Users to automatically log in as

SetUserName ()

SetUserName (in  's' name)

Sets the users username. Note that it is usually not allowed to have multiple users with the same username.

SetRealName ()

SetRealName (in  's' name)

Sets the users real name.

SetEmail ()

SetEmail (in  's' email)

Sets the users email address.

Note that setting an email address in the AccountsService is not the same as configuring a mail client. Mail clients might default to email address that is configured here, though.

SetLanguage ()

SetLanguage (in  's' language)

Sets the users language.

The expectation is that display managers will start the users session with this locale.

SetXSession ()

SetXSession (in  's' x_session)

Sets the users x session.

The expectation is that display managers will log the user in to this specified session, if available. Note this call is deprecated and has been superceded by SetSession since not all graphical sessions use X as the display server.

SetSession ()

SetSession (in  's' session)

Sets the users wayland or x session.

The expectation is that display managers will log the user in to this specified session, if available.

SetSessionType ()

SetSessionType (in  's' session_type)

Sets the session type of the users session.

Display managers may use this property to decide what type of display server to use when loading the session

SetLocation ()

SetLocation (in  's' location)

Sets the users location.

SetHomeDirectory ()

SetHomeDirectory (in  's' homedir)

Sets the users home directory.

Note that changing the users home directory moves all the content from the old location to the new one, and is potentially an expensive operation.

SetShell ()

SetShell (in  's' shell)

Sets the users shell.

Note that setting the shell to a non-allowed program may prevent the user from logging in.

SetIconFile ()

SetIconFile (in  's' filename)

Sets the users icon.

SetLocked ()

SetLocked (in  'b' locked)

Locks or unlocks a users account.

Locking an account prevents the user from logging in.

SetAccountType ()

SetAccountType (in  'i' accountType)

Changes the users account type.

SetPasswordMode ()

SetPasswordMode (in  'i' mode)

Changes the users password mode.

Note that changing the password mode has the side-effect of unlocking the account.

SetPassword ()

SetPassword (in  's' password,
             in  's' hint)

Sets a new password for this user.

Note that setting a password has the side-effect of unlocking the account.

SetPasswordHint ()

SetPasswordHint (in  's' hint)

Sets the users password hint.

SetAutomaticLogin ()

SetAutomaticLogin (in  'b' enabled)

Enables or disables automatic login for a user.

Note that usually only one user can have automatic login enabled, so turning it on for a user will disable it for the previously configured autologin user.

GetPasswordExpirationPolicy ()

GetPasswordExpirationPolicy (out 'x' expiration_time,
                             out 'x' last_change_time,
                             out 'x' min_days_between_changes,
                             out 'x' max_days_between_changes,
                             out 'x' days_to_warn,
                             out 'x' days_after_expiration_until_lock)

SetPasswordExpirationPolicy ()

SetPasswordExpirationPolicy (in  'x' min_days_between_changes,
                             in  'x' max_days_between_changes,
                             in  'x' days_to_warn,
                             in  'x' days_after_expiration_until_lock)

SetUserExpirationPolicy ()

SetUserExpirationPolicy (in  'x' expiration_time)

The Changed signal

Changed ()

Emitted when the user is changed.

The "Uid" property

'Uid'  read      't'

The uid of the user.

The "UserName" property

'UserName'  read      's'

The username of the user.

The "RealName" property

'RealName'  read      's'

The users real name.

The "AccountType" property

'AccountType'  read      'i'

The users account type, encoded as an integer:

The "HomeDirectory" property

'HomeDirectory'  read      's'

The users home directory.

The "Shell" property

'Shell'  read      's'

The users shell.

The "Email" property

'Email'  read      's'

The email address.

The "Language" property

'Language'  read      's'

The users language, as a locale specification like "de_DE.UTF-8".

The "Session" property

'Session'  read      's'

The users Wayland or X session.

The "SessionType" property

'SessionType'  read      's'

The type of session the user should use (e.g. "wayland" or "x11")

The "XSession" property

'XSession'  read      's'

The users x session.

The "Location" property

'Location'  read      's'

The users location.

The "LoginFrequency" property

'LoginFrequency'  read      't'

How often the user has logged in.

The "LoginTime" property

'LoginTime'  read      'x'

The last login time.

The "LoginHistory" property

'LoginHistory'  read      'a(xxa{sv})'

The login history for this user. Each entry in the array represents a login session. The first two members are the login time and logout time, as timestamps (seconds since the epoch). If the session is still running, the logout time is 0.

The a{sv} member is a dictionary containing additional information about the session. Possible members include 'type' (with values like ':0', 'tty0', 'pts/0' etc).

The "IconFile" property

'IconFile'  read      's'

The filename of a png file containing the users icon.

The "Saved" property

'Saved'  read      'b'

Whether the users account has retained state

The "Locked" property

'Locked'  read      'b'

Whether the users account is locked.

The "PasswordMode" property

'PasswordMode'  read      'i'

The password mode for the user account, encoded as an integer:

The "PasswordHint" property

'PasswordHint'  read      's'

The password hint for the user.

The "AutomaticLogin" property

'AutomaticLogin'  read      'b'

Whether automatic login is enabled for the user.

The "SystemAccount" property

'SystemAccount'  read      'b'

Whether this is a 'system' account, like 'root' or 'nobody'. System accounts should normally not appear in lists of users, and ListCachedUsers will not include such accounts.

The "LocalAccount" property

'LocalAccount'  read      'b'

Whether the user is a local account or not.