File: docbook-interface-org.freedesktop.PolicyKit1.Authority.xml

package info (click to toggle)
policykit-1 0.105-15~deb8u2
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 8,644 kB
  • ctags: 4,294
  • sloc: ansic: 18,560; sh: 11,430; xml: 3,384; makefile: 767
file content (960 lines) | stat: -rw-r--r-- 44,293 bytes parent folder | download | duplicates (5)
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2 //EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="eggdbus-interface-org.freedesktop.PolicyKit1.Authority">
  <refmeta>
    <refentrytitle role="top_of_page">org.freedesktop.PolicyKit1.Authority Interface</refentrytitle>
  </refmeta>
  <refnamediv>
    <refname>org.freedesktop.PolicyKit1.Authority Interface</refname>
    <refpurpose>Authority Interface</refpurpose>
  </refnamediv>
  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis>
Flags        <link linkend="eggdbus-enum-CheckAuthorizationFlags">CheckAuthorizationFlags</link>
Enumeration  <link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link>
ErrorDomain  <link linkend="eggdbus-errordomain-org.freedesktop.PolicyKit1.Error.">org.freedesktop.PolicyKit1.Error.*</link>
Flags        <link linkend="eggdbus-enum-AuthorityFeatures">AuthorityFeatures</link>
Structure    <link linkend="eggdbus-struct-Subject">Subject</link>
Structure    <link linkend="eggdbus-struct-Identity">Identity</link>
Structure    <link linkend="eggdbus-struct-ActionDescription">ActionDescription</link>
Structure    <link linkend="eggdbus-struct-AuthorizationResult">AuthorizationResult</link>
Structure    <link linkend="eggdbus-struct-TemporaryAuthorization">TemporaryAuthorization</link>

<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.EnumerateActions">EnumerateActions</link>                 (IN  String                         locale,
                                  OUT Array&lt;<link linkend="eggdbus-struct-ActionDescription">ActionDescription</link>&gt;       action_descriptions)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckAuthorization">CheckAuthorization</link>               (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                        subject,
                                  IN  String                         action_id,
                                  IN  Dict&lt;String,String&gt;            details,
                                  IN  <link linkend="eggdbus-enum-CheckAuthorizationFlags">CheckAuthorizationFlags</link>        flags,
                                  IN  String                         cancellation_id,
                                  OUT <link linkend="eggdbus-struct-AuthorizationResult">AuthorizationResult</link>            result)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CancelCheckAuthorization">CancelCheckAuthorization</link>         (IN  String                         cancellation_id)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent</link>      (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                        subject,
                                  IN  String                         locale,
                                  IN  String                         object_path)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgentWithOptions">RegisterAuthenticationAgentWithOptions</link> (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                  subject,
                                  IN  String                         locale,
                                  IN  String                         object_path,
                                  IN  Dict&lt;String,Variant&gt;     options)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.UnregisterAuthenticationAgent">UnregisterAuthenticationAgent</link>    (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                        subject,
                                  IN  String                         object_path)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse">AuthenticationAgentResponse</link>      (IN  String                         cookie,
                                  IN  <link linkend="eggdbus-struct-Identity">Identity</link>                       identity)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse2">AuthenticationAgentResponse2</link>      (IN uint32 uid, IN  String                         cookie,
                                  IN  <link linkend="eggdbus-struct-Identity">Identity</link>                       identity)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.EnumerateTemporaryAuthorizations">EnumerateTemporaryAuthorizations</link> (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                        subject,
                                  OUT Array&lt;<link linkend="eggdbus-struct-TemporaryAuthorization">TemporaryAuthorization</link>&gt;  temporary_authorizations)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RevokeTemporaryAuthorizations">RevokeTemporaryAuthorizations</link>    (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                        subject)
<link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RevokeTemporaryAuthorizationById">RevokeTemporaryAuthorizationById</link> (IN  String                         id)
    </synopsis>
  </refsynopsisdiv>
  <refsect1 role="signal_proto" id="eggdbus-if-signals-org.freedesktop.PolicyKit1.Authority">
    <title role="signal_proto.title">Signals</title>
    <synopsis>
<link linkend="eggdbus-signal-org.freedesktop.PolicyKit1.Authority::Changed">Changed</link> ()
    </synopsis>
  </refsect1>
  <refsect1 role="properties" id="eggdbus-if-properties-org.freedesktop.PolicyKit1.Authority">
    <title role="properties.title">Properties</title>
    <synopsis>
<link linkend="eggdbus-property-org.freedesktop.PolicyKit1.Authority:BackendName">BackendName</link>         readable     String
<link linkend="eggdbus-property-org.freedesktop.PolicyKit1.Authority:BackendVersion">BackendVersion</link>      readable     String
<link linkend="eggdbus-property-org.freedesktop.PolicyKit1.Authority:BackendFeatures">BackendFeatures</link>     readable     <link linkend="eggdbus-enum-AuthorityFeatures">AuthorityFeatures</link>
    </synopsis>
  </refsect1>
  <refsect1 role="desc" id="eggdbus-if-description-org.freedesktop.PolicyKit1.Authority">
    <title role="desc.title">Description</title>
      <para>
This D-Bus interface is implemented by the <literal>/org/freedesktop/PolicyKit1/Authority</literal> object on the well-known name <literal>org.freedesktop.PolicyKit1</literal> on the system message bus.
      </para>
  </refsect1>
  <refsect1 role="desc" id="eggdbus-if-enumerations-org.freedesktop.PolicyKit1.Authority">
    <title role="desc.title">Enumerations</title>
    <refsect2 role="enum" id="eggdbus-enum-CheckAuthorizationFlags">
      <title>The CheckAuthorizationFlags Flags</title>
        <para>
          <programlisting>
{
  None                 = 0x00000000,
  AllowUserInteraction = 0x00000001
}
          </programlisting>
          <para>
Flags used in the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckAuthorization">CheckAuthorization()</link> method.
          </para>
          <variablelist role="constant">
  <varlistentry id="eggdbus-constant-CheckAuthorizationFlags.None" role="constant">
    <term><literal>None</literal></term>
    <listitem>
      <para>
No flags set.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-CheckAuthorizationFlags.AllowUserInteraction" role="constant">
    <term><literal>AllowUserInteraction</literal></term>
    <listitem>
      <para>
If the <link linkend="eggdbus-struct-Subject">Subject</link> can obtain the authorization through authentication, and an authentication agent is available, then attempt to do so. Note, this means that the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckAuthorization">CheckAuthorization()</link> method will block while the user is being asked to authenticate.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
    <refsect2 role="enum" id="eggdbus-enum-ImplicitAuthorization">
      <title>The ImplicitAuthorization Enumeration</title>
        <para>
          <programlisting>
{
  NotAuthorized                               = 0,
  AuthenticationRequired                      = 1,
  AdministratorAuthenticationRequired         = 2,
  AuthenticationRequiredRetained              = 3,
  AdministratorAuthenticationRequiredRetained = 4,
  Authorized                                  = 5
}
          </programlisting>
          <para>
An enumeration for granting implicit authorizations.
          </para>
          <variablelist role="constant">
  <varlistentry id="eggdbus-constant-ImplicitAuthorization.NotAuthorized" role="constant">
    <term><literal>NotAuthorized</literal></term>
    <listitem>
      <para>
The <link linkend="eggdbus-struct-Subject">Subject</link> is not authorized.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-ImplicitAuthorization.AuthenticationRequired" role="constant">
    <term><literal>AuthenticationRequired</literal></term>
    <listitem>
      <para>
Authentication is required.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-ImplicitAuthorization.AdministratorAuthenticationRequired" role="constant">
    <term><literal>AdministratorAuthenticationRequired</literal></term>
    <listitem>
      <para>
Authentication as an administrator is required.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-ImplicitAuthorization.AuthenticationRequiredRetained" role="constant">
    <term><literal>AuthenticationRequiredRetained</literal></term>
    <listitem>
      <para>
Authentication is required. If the authorization is obtained, it is retained.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-ImplicitAuthorization.AdministratorAuthenticationRequiredRetained" role="constant">
    <term><literal>AdministratorAuthenticationRequiredRetained</literal></term>
    <listitem>
      <para>
Authentication as an administrator is required. If the authorization is obtained, it is retained.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-ImplicitAuthorization.Authorized" role="constant">
    <term><literal>Authorized</literal></term>
    <listitem>
      <para>
The subject is authorized.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
    <refsect2 role="enum" id="eggdbus-errordomain-org.freedesktop.PolicyKit1.Error.">      <title>The org.freedesktop.PolicyKit1.Error.* Error Domain</title>
        <para>
          <programlisting>
{
  org.freedesktop.PolicyKit1.Error.Failed,
  org.freedesktop.PolicyKit1.Error.Cancelled,
  org.freedesktop.PolicyKit1.Error.NotSupported,
  org.freedesktop.PolicyKit1.Error.NotAuthorized,
  org.freedesktop.PolicyKit1.Error.CancellationIdNotUnique
}
          </programlisting>
          <para>
Errors that can be returned by various method calls.
          </para>
          <variablelist role="constant">
  <varlistentry id="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.Failed" role="constant">
    <term><literal>org.freedesktop.PolicyKit1.Error.Failed</literal></term>
    <listitem>
      <para>
The operation failed.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.Cancelled" role="constant">
    <term><literal>org.freedesktop.PolicyKit1.Error.Cancelled</literal></term>
    <listitem>
      <para>
The operation was cancelled.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.NotSupported" role="constant">
    <term><literal>org.freedesktop.PolicyKit1.Error.NotSupported</literal></term>
    <listitem>
      <para>
The operation is not supported.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.NotAuthorized" role="constant">
    <term><literal>org.freedesktop.PolicyKit1.Error.NotAuthorized</literal></term>
    <listitem>
      <para>
You are not authorized to perform the requested operation.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.CancellationIdNotUnique" role="constant">
    <term><literal>org.freedesktop.PolicyKit1.Error.CancellationIdNotUnique</literal></term>
    <listitem>
      <para>
The passed <parameter>cancellation_id</parameter> is already in use.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
    <refsect2 role="enum" id="eggdbus-enum-AuthorityFeatures">
      <title>The AuthorityFeatures Flags</title>
        <para>
          <programlisting>
{
  None                   = 0x00000000,
  TemporaryAuthorization = 0x00000001
}
          </programlisting>
          <para>
Flags describing features supported by the Authority implementation.
          </para>
          <variablelist role="constant">
  <varlistentry id="eggdbus-constant-AuthorityFeatures.None" role="constant">
    <term><literal>None</literal></term>
    <listitem>
      <para>
No flags set.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry id="eggdbus-constant-AuthorityFeatures.TemporaryAuthorization" role="constant">
    <term><literal>TemporaryAuthorization</literal></term>
    <listitem>
      <para>
The authority supports temporary authorizations that can be obtained through authentication.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
  </refsect1>
  <refsect1 role="desc" id="eggdbus-if-structures-org.freedesktop.PolicyKit1.Authority">
    <title role="desc.title">Structures</title>
    <refsect2 role="struct" id="eggdbus-struct-Subject">
      <title>The Subject Structure</title>
        <para>
          <programlisting>
{
  String               subject_kind,
  Dict&lt;String,Variant&gt; subject_details
}
          </programlisting>
          <para>
<para>This struct describes subjects such as UNIX processes. It is typically used to check if a given process is authorized for an action.</para><para>The following kinds of subjects are known:</para>                   <formalpara><title>Unix Process</title><para><literal>subject_kind</literal> should be set to <literal>unix-process</literal> with keys <literal>pid</literal> (of type <literal>uint32</literal>) and <literal>start-time</literal> (of type <literal>uint64</literal>).</para></formalpara>                   <formalpara><title>Unix Session</title><para><literal>subject_kind</literal> should be set to <literal>unix-session</literal> with the key <literal>session-id</literal> (of type <literal>string</literal>).</para></formalpara>                   <formalpara><title>System Bus Name</title><para><literal>subject_kind</literal> should be set to <literal>system-bus-name</literal> with the key <literal>name</literal> (of type <literal>string</literal>).</para></formalpara>
          </para>
          <variablelist role="struct">
  <varlistentry>
    <term><literal>String <structfield>subject_kind</structfield></literal></term>
    <listitem>
      <para>
The type of the subject.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>Dict&lt;String,Variant&gt; <structfield>subject_details</structfield></literal></term>
    <listitem>
      <para>
Details about the subject. Depending of the value of <parameter>subject_kind</parameter>, a set of well-defined key/value pairs are guaranteed to be available.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
    <refsect2 role="struct" id="eggdbus-struct-Identity">
      <title>The Identity Structure</title>
        <para>
          <programlisting>
{
  String               identity_kind,
  Dict&lt;String,Variant&gt; identity_details
}
          </programlisting>
          <para>
<para>This struct describes identities such as UNIX users and UNIX groups. It is typically used to check if a given process is authorized for an action.</para><para>The following kinds of identities are known:</para>                   <formalpara><title>Unix User</title><para><literal>identity_kind</literal> should be set to <literal>unix-user</literal> with key <literal>uid</literal> (of type <literal>uint32</literal>).</para></formalpara>                   <formalpara><title>Unix Group</title><para><literal>identity_kind</literal> should be set to <literal>unix-group</literal> with key <literal>gid</literal> (of type <literal>uint32</literal>).</para></formalpara>  
          </para>
          <variablelist role="struct">
  <varlistentry>
    <term><literal>String <structfield>identity_kind</structfield></literal></term>
    <listitem>
      <para>
Type of identity.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>Dict&lt;String,Variant&gt; <structfield>identity_details</structfield></literal></term>
    <listitem>
      <para>
Details about the identity. Depending of the value of <parameter>identity_kind</parameter>, a set of well-defined key/value pairs are guaranteed to be available.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
    <refsect2 role="struct" id="eggdbus-struct-ActionDescription">
      <title>The ActionDescription Structure</title>
        <para>
          <programlisting>
{
  String                action_id,
  String                description,
  String                message,
  String                vendor_name,
  String                vendor_url,
  String                icon_name,
  <link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link> implicit_any,
  <link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link> implicit_inactive,
  <link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link> implicit_active,
  Dict&lt;String,String&gt;   annotations
}
          </programlisting>
          <para>
This struct describes actions registered with the PolicyKit daemon.
          </para>
          <variablelist role="struct">
  <varlistentry>
    <term><literal>String <structfield>action_id</structfield></literal></term>
    <listitem>
      <para>
Action Identifier.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>String <structfield>description</structfield></literal></term>
    <listitem>
      <para>
Localized description of the action.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>String <structfield>message</structfield></literal></term>
    <listitem>
      <para>
Localized message to be displayed when making the user authenticate for an action.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>String <structfield>vendor_name</structfield></literal></term>
    <listitem>
      <para>
Name of the provider of the action or the empty string.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>String <structfield>vendor_url</structfield></literal></term>
    <listitem>
      <para>
A URL pointing to a place with more information about the action or the empty string.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>String <structfield>icon_name</structfield></literal></term>
    <listitem>
      <para>
The themed icon describing the action or the empty string if no icon is set.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal><link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link> <structfield>implicit_any</structfield></literal></term>
    <listitem>
      <para>
A value from the <link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link>. enumeration for implicit authorizations that apply to any <link linkend="eggdbus-struct-Subject">Subject</link>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal><link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link> <structfield>implicit_inactive</structfield></literal></term>
    <listitem>
      <para>
A value from the <link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link>. enumeration for implicit authorizations that apply any <link linkend="eggdbus-struct-Subject">Subject</link> in an inactive user session on the local console.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal><link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link> <structfield>implicit_active</structfield></literal></term>
    <listitem>
      <para>
A value from the <link linkend="eggdbus-enum-ImplicitAuthorization">ImplicitAuthorization</link>. enumeration for implicit authorizations that apply any <link linkend="eggdbus-struct-Subject">Subject</link> in an active user session on the local console.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>Dict&lt;String,String&gt; <structfield>annotations</structfield></literal></term>
    <listitem>
      <para>
Annotations for the action.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
    <refsect2 role="struct" id="eggdbus-struct-AuthorizationResult">
      <title>The AuthorizationResult Structure</title>
        <para>
          <programlisting>
{
  Boolean             is_authorized,
  Boolean             is_challenge,
  Dict&lt;String,String&gt; details
}
          </programlisting>
          <para>
Describes the result of calling <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckAuthorization">CheckAuthorization()</link>.
          </para>
          <variablelist role="struct">
  <varlistentry>
    <term><literal>Boolean <structfield>is_authorized</structfield></literal></term>
    <listitem>
      <para>
TRUE if the given <link linkend="eggdbus-struct-Subject">Subject</link> is authorized for the given action.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>Boolean <structfield>is_challenge</structfield></literal></term>
    <listitem>
      <para>
TRUE if the given <link linkend="eggdbus-struct-Subject">Subject</link> could be authorized if more information was provided, and <link linkend="eggdbus-constant-CheckAuthorizationFlags.AllowUserInteraction">CheckAuthorizationFlags.AllowUserInteraction</link> wasn't passed or no suitable authentication agent was available.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>Dict&lt;String,String&gt; <structfield>details</structfield></literal></term>
    <listitem>
      <para>
Details for the result. Known key/value-pairs include <literal>polkit.temporary_authorization_id</literal> (if the authorization is temporary, this is set to the opaque temporary authorization id), <literal>polkit.retains_authorization_after_challenge</literal> (Set to a non-empty string if the authorization will be retained after authentication (if is_challenge is TRUE)), <literal>polkit.dismissed</literal> (Set to a non-empty string if the authentication dialog was dismissed by the user).
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
    <refsect2 role="struct" id="eggdbus-struct-TemporaryAuthorization">
      <title>The TemporaryAuthorization Structure</title>
        <para>
          <programlisting>
{
  String  id,
  String  action_id,
  <link linkend="eggdbus-struct-Subject">Subject</link> subject,
  UInt64  time_obtained,
  UInt64  time_expires
}
          </programlisting>
          <para>
This struct describes a temporary authorization.
          </para>
          <variablelist role="struct">
  <varlistentry>
    <term><literal>String <structfield>id</structfield></literal></term>
    <listitem>
      <para>
An opaque identifier for the temporary authorization.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>String <structfield>action_id</structfield></literal></term>
    <listitem>
      <para>
The action the temporary authorization is for.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal><link linkend="eggdbus-struct-Subject">Subject</link> <structfield>subject</structfield></literal></term>
    <listitem>
      <para>
The subject the temporary authorization is for.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>UInt64 <structfield>time_obtained</structfield></literal></term>
    <listitem>
      <para>
When the temporary authorization was obtained, in seconds since the Epoch Jan 1, 1970 0:00 UTC.
Note that the PolicyKit daemon is using monotonic time internally so the returned value may change if system time changes.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>UInt64 <structfield>time_expires</structfield></literal></term>
    <listitem>
      <para>
When the temporary authorization is set to expire, in seconds since the Epoch Jan 1, 1970 0:00 UTC.
Note that the PolicyKit daemon is using monotonic time internally so the returned value may change if system time changes.
      </para>
    </listitem>
  </varlistentry>
          </variablelist>
        </para>
    </refsect2>
  </refsect1>
  <refsect1 role="details" id="eggdbus-if-method-details-org.freedesktop.PolicyKit1.Authority">
    <title role="details.title">Method Details</title>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.EnumerateActions">
      <title>EnumerateActions ()</title>
    <programlisting>
EnumerateActions (IN  String                    locale,
                  OUT Array&lt;<link linkend="eggdbus-struct-ActionDescription">ActionDescription</link>&gt;  action_descriptions)
    </programlisting>
    <para>
Enumerates all registered PolicyKit actions.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  String <parameter>locale</parameter></literal>:</term>
    <listitem>
      <para>
The locale to get descriptions in or the blank string to use the system locale.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>OUT Array&lt;<link linkend="eggdbus-struct-ActionDescription">ActionDescription</link>&gt; <parameter>action_descriptions</parameter></literal>:</term>
    <listitem>
      <para>
An array of <link linkend="eggdbus-struct-ActionDescription">ActionDescription</link> structs.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckAuthorization">
      <title>CheckAuthorization ()</title>
    <programlisting>
CheckAuthorization (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                  subject,
                    IN  String                   action_id,
                    IN  Dict&lt;String,String&gt;      details,
                    IN  <link linkend="eggdbus-enum-CheckAuthorizationFlags">CheckAuthorizationFlags</link>  flags,
                    IN  String                   cancellation_id,
                    OUT <link linkend="eggdbus-struct-AuthorizationResult">AuthorizationResult</link>      result)
    </programlisting>
    <para>
      <para>
        Checks if <parameter>subject</parameter> is authorized to
        perform the action with identifier
        <parameter>action_id</parameter>
      </para>
      <para>
        If <parameter>cancellation_id</parameter> is non-empty and
        already in use for the caller, the <link
        linkend="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.CancellationIdNotUnique">org.freedesktop.PolicyKit1.Error.CancellationIdNotUnique</link>
        error is returned.
      </para>
      <para>
        Note that <link
        linkend="eggdbus-constant-CheckAuthorizationFlags.AllowUserInteraction">CheckAuthorizationFlags.AllowUserInteraction</link>
        SHOULD be passed ONLY if the event that triggered the
        authorization check is stemming from an user action, e.g. the
        user pressing a button or attaching a device.
      </para>
      <para>
      </para>
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-struct-Subject">Subject</link> <parameter>subject</parameter></literal>:</term>
    <listitem>
      <para>
A <link linkend="eggdbus-struct-Subject">Subject</link> struct.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  String <parameter>action_id</parameter></literal>:</term>
    <listitem>
      <para>
Identifier for the action that <parameter>subject</parameter> is attempting to do.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  Dict&lt;String,String&gt; <parameter>details</parameter></literal>:</term>
    <listitem>
      <para>
Details describing the action. Keys starting with <literal>polkit.</literal> are can only be set if defined in this document.
      </para>
      <para>
        Known keys include <literal>polkit.message</literal> and
        <literal>polkit.gettext_domain</literal> that can be used to
        override the message shown to the user. This latter is needed
        because the user could be running an authentication agent in
        another locale than the calling process.
      </para>
      <para>
        The (translated version of) <literal>polkit.message</literal>
        may include references to other keys that are expanded with
        their respective values. For example if the key
        <literal>device_file</literal> has the value
        <literal>/dev/sda</literal> then the message
        "<literal>Authenticate to format $(device_file)</literal>" is
        expanded to "<literal>Authenticate to format
        /dev/sda</literal>".
      </para>
      <para>
        The key <literal>polkit.icon_name</literal> is used to override the icon shown in the authentication dialog.
      </para>
      <para>
        If non-empty, then the request will fail with
        <link linkend="eggdbus-constant-Error.org.freedesktop.PolicyKit1.Error.Failed">org.freedesktop.PolicyKit1.Error.Failed</link>
        unless the process doing the check itsef is sufficiently authorized (e.g. running as uid 0).
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-enum-CheckAuthorizationFlags">CheckAuthorizationFlags</link> <parameter>flags</parameter></literal>:</term>
    <listitem>
      <para>
A set of <link linkend="eggdbus-enum-CheckAuthorizationFlags">CheckAuthorizationFlags</link>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  String <parameter>cancellation_id</parameter></literal>:</term>
    <listitem>
      <para>
A unique id used to cancel the the authentication check via <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CancelCheckAuthorization">CancelCheckAuthorization()</link> or the empty string if cancellation is not needed.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>OUT <link linkend="eggdbus-struct-AuthorizationResult">AuthorizationResult</link> <parameter>result</parameter></literal>:</term>
    <listitem>
      <para>
An <link linkend="eggdbus-struct-AuthorizationResult">AuthorizationResult</link> structure.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CancelCheckAuthorization">
      <title>CancelCheckAuthorization ()</title>
    <programlisting>
CancelCheckAuthorization (IN  String  cancellation_id)
    </programlisting>
    <para>
Cancels an authorization check.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  String <parameter>cancellation_id</parameter></literal>:</term>
    <listitem>
      <para>
The <parameter>cancellation_id</parameter> passed to <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckAuthorization">CheckAuthorization()</link>.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">
      <title>RegisterAuthenticationAgent ()</title>
    <programlisting>
RegisterAuthenticationAgent (IN  <link linkend="eggdbus-struct-Subject">Subject</link>  subject,
                             IN  String   locale,
                             IN  String   object_path)
    </programlisting>
    <para>
<para>Register an authentication agent.</para><para>Note that this should be called by same effective UID which will be passed to <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse2">AuthenticationAgentResponse2()</link>.</para>
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-struct-Subject">Subject</link> <parameter>subject</parameter></literal>:</term>
    <listitem>
      <para>
The subject to register the authentication agent for, typically a session subject.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  String <parameter>locale</parameter></literal>:</term>
    <listitem>
      <para>
The locale of the authentication agent.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  String <parameter>object_path</parameter></literal>:</term>
    <listitem>
      <para>
The object path of authentication agent object on the unique name of the caller.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>

    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgentWithOptions">
      <title>RegisterAuthenticationAgentWithOptions ()</title>
    <programlisting>
RegisterAuthenticationAgentWithOptions (IN  <link linkend="eggdbus-struct-Subject">Subject</link>  subject,
                                        IN  String                   locale,
                                        IN  String                   object_path,
                                        IN  Dict&lt;String,Variant&gt;     options)
    </programlisting>
    <para>
<para>Like <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent</link> but takes additional options. If the option <literal>fallback</literal> (of type <literal>Boolean</literal>) is TRUE, then the authentcation agent will only be used as a fallback, e.g. if another agent (without the <literal>fallback</literal> option set TRUE) is available, it will be used instead.</para>
    </para>
    </refsect2>

    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.UnregisterAuthenticationAgent">
      <title>UnregisterAuthenticationAgent ()</title>
    <programlisting>
UnregisterAuthenticationAgent (IN  <link linkend="eggdbus-struct-Subject">Subject</link>  subject,
                               IN  String   object_path)
    </programlisting>
    <para>
Unregister an authentication agent.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-struct-Subject">Subject</link> <parameter>subject</parameter></literal>:</term>
    <listitem>
      <para>
The <parameter>subject</parameter> passed to <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent()</link>.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  String <parameter>object_path</parameter></literal>:</term>
    <listitem>
      <para>
The <parameter>object_path</parameter> passed to <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent()</link>.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse">
      <title>AuthenticationAgentResponse ()</title>
    <programlisting>
AuthenticationAgentResponse (IN  String    cookie,
                             IN  <link linkend="eggdbus-struct-Identity">Identity</link>  identity)
    </programlisting>
    <para>
Method for authentication agents to invoke on successful
authentication, intended only for use by a privileged helper process
internal to polkit. This method will fail unless a sufficiently privileged
+caller invokes it. Deprecated in favor of <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse2">AuthenticationAgentResponse2()</link>.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  String <parameter>cookie</parameter></literal>:</term>
    <listitem>
      <para>
The cookie identifying the authentication request that was passed to the authentication agent.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-struct-Identity">Identity</link> <parameter>identity</parameter></literal>:</term>
    <listitem>
      <para>
A <link linkend="eggdbus-struct-Identity">Identity</link> struct describing what identity was authenticated.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse2">
      <title>AuthenticationAgentResponse2 ()</title>
    <programlisting>
AuthenticationAgentResponse2 (IN  uint32 uid,
                              IN  String cookie,
                              IN  <link linkend="eggdbus-struct-Identity">Identity</link>  identity)
    </programlisting>
    <para>
Method for authentication agents to invoke on successful
authentication, intended only for use by a privileged helper process
internal to polkit. This method will fail unless a sufficiently privileged
caller invokes it. Note this method was introduced in 0.114 and should be
preferred over <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse">AuthenticationAgentResponse()</link>
as it fixes a security issue.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  uint32 <parameter>uid</parameter></literal>:</term>
    <listitem>
      <para>
The user id of the agent; normally this is the owner of the parent pid
of the process that invoked the internal setuid helper.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  String <parameter>cookie</parameter></literal>:</term>
    <listitem>
      <para>
The cookie identifying the authentication request that was passed to the authentication agent.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-struct-Identity">Identity</link> <parameter>identity</parameter></literal>:</term>
    <listitem>
      <para>
A <link linkend="eggdbus-struct-Identity">Identity</link> struct describing what identity was authenticated.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.EnumerateTemporaryAuthorizations">
      <title>EnumerateTemporaryAuthorizations ()</title>
    <programlisting>
EnumerateTemporaryAuthorizations (IN  <link linkend="eggdbus-struct-Subject">Subject</link>                        subject,
                                  OUT Array&lt;<link linkend="eggdbus-struct-TemporaryAuthorization">TemporaryAuthorization</link>&gt;  temporary_authorizations)
    </programlisting>
    <para>
Retrieves all temporary authorizations that applies to <parameter>subject</parameter>.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-struct-Subject">Subject</link> <parameter>subject</parameter></literal>:</term>
    <listitem>
      <para>
The subject to get temporary authorizations for.
      </para>
    </listitem>
  </varlistentry>
  <varlistentry>
    <term><literal>OUT Array&lt;<link linkend="eggdbus-struct-TemporaryAuthorization">TemporaryAuthorization</link>&gt; <parameter>temporary_authorizations</parameter></literal>:</term>
    <listitem>
      <para>
An array of <link linkend="eggdbus-struct-TemporaryAuthorization">TemporaryAuthorization</link> structs.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RevokeTemporaryAuthorizations">
      <title>RevokeTemporaryAuthorizations ()</title>
    <programlisting>
RevokeTemporaryAuthorizations (IN  <link linkend="eggdbus-struct-Subject">Subject</link>  subject)
    </programlisting>
    <para>
Revokes all temporary authorizations that applies to <parameter>subject</parameter>.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  <link linkend="eggdbus-struct-Subject">Subject</link> <parameter>subject</parameter></literal>:</term>
    <listitem>
      <para>
The subject to revoke temporary authorizations from.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
    <refsect2 role="function" id="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RevokeTemporaryAuthorizationById">
      <title>RevokeTemporaryAuthorizationById ()</title>
    <programlisting>
RevokeTemporaryAuthorizationById (IN  String  id)
    </programlisting>
    <para>
Revokes all temporary authorizations that applies to <parameter>subject</parameter>.
    </para>
<variablelist role="params">
  <varlistentry>
    <term><literal>IN  String <parameter>id</parameter></literal>:</term>
    <listitem>
      <para>
The opaque identifier of the temporary authorization.
      </para>
    </listitem>
  </varlistentry>
</variablelist>
    </refsect2>
  </refsect1>
  <refsect1 role="signals" id="eggdbus-if-signal-details-org.freedesktop.PolicyKit1.Authority">
    <title role="signals.title">Signal Details</title>
    <refsect2 role="signal" id="eggdbus-signal-org.freedesktop.PolicyKit1.Authority::Changed">
      <title>The "Changed" signal</title>
    <programlisting>
Changed ()
    </programlisting>
    <para>
This signal is emitted when actions and/or authorizations change
    </para>
<variablelist role="params">
</variablelist>
    </refsect2>
  </refsect1>
  <refsect1 role="property_details" id="eggdbus-if-property-details-org.freedesktop.PolicyKit1.Authority">
    <title role="property_details.title">Property Details</title>
    <refsect2 role="property" id="eggdbus-property-org.freedesktop.PolicyKit1.Authority:BackendName">
      <title>The "BackendName" property</title>
    <programlisting>
BackendName     readable     String
    </programlisting>
    <para>
The name of the currently used Authority backend.
    </para>
    </refsect2>
    <refsect2 role="property" id="eggdbus-property-org.freedesktop.PolicyKit1.Authority:BackendVersion">
      <title>The "BackendVersion" property</title>
    <programlisting>
BackendVersion     readable     String
    </programlisting>
    <para>
The version of the currently used Authority backend.
    </para>
    </refsect2>
    <refsect2 role="property" id="eggdbus-property-org.freedesktop.PolicyKit1.Authority:BackendFeatures">
      <title>The "BackendFeatures" property</title>
    <programlisting>
BackendFeatures     readable     <link linkend="eggdbus-enum-AuthorityFeatures">AuthorityFeatures</link>
    </programlisting>
    <para>
The features supported by the currently used Authority backend.
    </para>
    </refsect2>
  </refsect1>
</refentry>