aboutsummaryrefslogtreecommitdiff
path: root/src/backend-dbus/org.freedesktop.Accounts.xml
blob: 9c19761b1ad691b7bd668567b9724ce4123df338 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" >
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  <interface name="org.freedesktop.Accounts">

    <!-- ************************************************************ -->

    <method name="ListCachedUsers">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="users" direction="out" type="ao">
        <doc:doc><doc:summary>Object paths of cached users</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            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 <doc:ref type="method" to="Accounts.FindUserByName">FindUserByName()</doc:ref>
            to return a user that's not on the list.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <method name="FindUserById">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="id" direction="in" type="x">
        <doc:doc><doc:summary>The uid to look up</doc:summary></doc:doc>
      </arg>
      <arg name="user" direction="out" type="o">
        <doc:doc><doc:summary>Object path of user</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Finds a user by uid.
          </doc:para>
        </doc:description>
        <doc:errors>
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if no user with the given uid exists</doc:error>
        </doc:errors>
      </doc:doc>
    </method>

    <method name="FindUserByName">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name" direction="in" type="s">
        <doc:doc><doc:summary>The username to look up</doc:summary></doc:doc>
      </arg>
      <arg name="user" direction="out" type="o">
        <doc:doc><doc:summary>Object path of user</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Finds a user by its username.
          </doc:para>
        </doc:description>
        <doc:errors>
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if no user with the given username exists</doc:error>
        </doc:errors>
      </doc:doc>
    </method>

    <method name="CreateUser">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="name" direction="in" type="s">
        <doc:doc><doc:summary>The username for the new user</doc:summary></doc:doc>
      </arg>
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="fullname" direction="in" type="s">
        <doc:doc><doc:summary>The real name for the new user</doc:summary></doc:doc>
      </arg>
      <arg name="user" direction="out" type="o">
        <doc:doc><doc:summary>Object path of the new user</doc:summary></doc:doc>
      </arg>
      <arg name="accountType" direction="in" type="i">
        <doc:doc>
          <doc:summary>The account type, encoded as an integer</doc:summary>
        </doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Creates a new user account.
          </doc:para>
          <doc:para>
          The accountType argument can take the following values:
          </doc:para>
            <doc:list>
              <doc:item>
                <doc:term>0</doc:term>
                <doc:definition>Standard user</doc:definition>
              </doc:item>
              <doc:item>
                <doc:term>1</doc:term>
                <doc:definition>Administrator</doc:definition>
              </doc:item>
              <doc:item>
                <doc:term>2</doc:term>
                <doc:definition>Supervised user</doc:definition>
              </doc:item>
            </doc:list>
        </doc:description>
        <doc:permission>
          The caller needs the org.freedesktop.accounts.user-administration PolicyKit authorization.
        </doc:permission>
        <doc:errors>
          <doc:error name="org.freedesktop.Accounts.Error.PermissionDenied">if the caller lacks the appropriate PolicyKit authorization</doc:error>
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if the operation failed</doc:error>
        </doc:errors>
      </doc:doc>
    </method>

    <method name="DeleteUser">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="id" direction="in" type="x">
        <doc:doc><doc:summary>The uid to delete</doc:summary></doc:doc>
      </arg>
      <arg name="removeFiles" direction="in" type="b">
        <doc:doc><doc:summary>Whether to remove the users files</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Deletes a user account.
          </doc:para>
        </doc:description>
        <doc:permission>
          The caller needs the org.freedesktop.accounts.user-administration PolicyKit authorization.
        </doc:permission>
        <doc:errors>
          <doc:error name="org.freedesktop.Accounts.Error.PermissionDenied">if the caller lacks the appropriate PolicyKit authorization</doc:error>
          <doc:error name="org.freedesktop.Accounts.Error.Failed">if the operation failed</doc:error>
        </doc:errors>
      </doc:doc>
    </method>

    <signal name="UserAdded">
      <arg name="user" type="o">
        <doc:doc><doc:summary>Object path of the user that was added.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Emitted when a user is added.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

    <signal name="UserDeleted">
      <arg name="user" type="o">
        <doc:doc><doc:summary>Object path of the user that was deleted.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Emitted when a user is deleted.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

    <signal name="UserChanged">
      <arg name="user" type="o">
        <doc:doc><doc:summary>Object path of the user that was changed.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Emitted when a user is changed.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

   <property name="DaemonVersion" type="s" access="read">
     <doc:doc>
       <doc:description>
         <doc:para>
           The version of the running daemon.
         </doc:para>
       </doc:description>
     </doc:doc>
   </property>

  </interface>
</node>