Debian Codegraph @

docs/dyn/admin_directory_v1.groups.aliases.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.groups.html">groups</a> . <a href="admin_directory_v1.groups.aliases.html">aliases</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#delete">delete(groupKey, alias, x__xgafv=None)</a></code></p>
82 <p class="firstline">Removes an alias.</p>
83 <p class="toc_element">
84 <code><a href="#insert">insert(groupKey, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Adds an alias for the group.</p>
86 <p class="toc_element">
87 <code><a href="#list">list(groupKey, x__xgafv=None)</a></code></p>
88 <p class="firstline">Lists all aliases for a group.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="delete">delete(groupKey, alias, x__xgafv=None)</code>
97 <pre>Removes an alias.
98
99 Args:
100 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
101 alias: string, The alias to be removed (required)
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106 </pre>
107 </div>
108
109 <div class="method">
110 <code class="details" id="insert">insert(groupKey, body=None, x__xgafv=None)</code>
111 <pre>Adds an alias for the group.
112
113 Args:
114 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
115 body: object, The request body.
116 The object takes the form of:
117
118 { # JSON template for Alias object in Directory API.
119 &quot;alias&quot;: &quot;A String&quot;,
120 &quot;etag&quot;: &quot;A String&quot;,
121 &quot;id&quot;: &quot;A String&quot;,
122 &quot;kind&quot;: &quot;admin#directory#alias&quot;,
123 &quot;primaryEmail&quot;: &quot;A String&quot;,
124 }
125
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131 Returns:
132 An object of the form:
133
134 { # JSON template for Alias object in Directory API.
135 &quot;alias&quot;: &quot;A String&quot;,
136 &quot;etag&quot;: &quot;A String&quot;,
137 &quot;id&quot;: &quot;A String&quot;,
138 &quot;kind&quot;: &quot;admin#directory#alias&quot;,
139 &quot;primaryEmail&quot;: &quot;A String&quot;,
140 }</pre>
141 </div>
142
143 <div class="method">
144 <code class="details" id="list">list(groupKey, x__xgafv=None)</code>
145 <pre>Lists all aliases for a group.
146
147 Args:
148 groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154 Returns:
155 An object of the form:
156
157 { # JSON response template to list aliases in Directory API.
158 &quot;aliases&quot;: [
159 &quot;&quot;,
160 ],
161 &quot;etag&quot;: &quot;A String&quot;,
162 &quot;kind&quot;: &quot;admin#directory#aliases&quot;,
163 }</pre>
164 </div>
165
166 </body></html>