1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="admin_directory_v1.groups.aliases.html">aliases()</a></code> 79</p> 80<p class="firstline">Returns the aliases Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#delete">delete(groupKey, x__xgafv=None)</a></code></p> 87<p class="firstline">Deletes a group.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(groupKey, x__xgafv=None)</a></code></p> 90<p class="firstline">Retrieves a group's properties.</p> 91<p class="toc_element"> 92 <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Creates a group.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, query=None, sortOrder=None, userKey=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Retrieves all groups of a domain or of a user given a userKey (paginated).</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#patch">patch(groupKey, body=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).</p> 103<p class="toc_element"> 104 <code><a href="#update">update(groupKey, body=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates a group's properties.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="delete">delete(groupKey, x__xgafv=None)</code> 114 <pre>Deletes a group. 115 116Args: 117 groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required) 118 x__xgafv: string, V1 error format. 119 Allowed values 120 1 - v1 error format 121 2 - v2 error format 122</pre> 123</div> 124 125<div class="method"> 126 <code class="details" id="get">get(groupKey, x__xgafv=None)</code> 127 <pre>Retrieves a group's properties. 128 129Args: 130 groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required) 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 140 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 141 "aliases": [ # List of a group's alias email addresses. 142 "A String", 143 ], 144 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 145 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 146 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 147 "etag": "A String", # ETag of the resource. 148 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 149 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 150 "name": "A String", # The group's display name. 151 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 152 "A String", 153 ], 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="insert">insert(body=None, x__xgafv=None)</code> 159 <pre>Creates a group. 160 161Args: 162 body: object, The request body. 163 The object takes the form of: 164 165{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 166 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 167 "aliases": [ # List of a group's alias email addresses. 168 "A String", 169 ], 170 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 171 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 172 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 173 "etag": "A String", # ETag of the resource. 174 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 175 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 176 "name": "A String", # The group's display name. 177 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 178 "A String", 179 ], 180} 181 182 x__xgafv: string, V1 error format. 183 Allowed values 184 1 - v1 error format 185 2 - v2 error format 186 187Returns: 188 An object of the form: 189 190 { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 191 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 192 "aliases": [ # List of a group's alias email addresses. 193 "A String", 194 ], 195 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 196 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 197 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 198 "etag": "A String", # ETag of the resource. 199 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 200 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 201 "name": "A String", # The group's display name. 202 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 203 "A String", 204 ], 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="list">list(customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, query=None, sortOrder=None, userKey=None, x__xgafv=None)</code> 210 <pre>Retrieves all groups of a domain or of a user given a userKey (paginated). 211 212Args: 213 customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) 214 domain: string, The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the `customer` query parameter instead. 215 maxResults: integer, Maximum number of results to return. Max allowed value is 200. 216 orderBy: string, Column to use for sorting results 217 Allowed values 218 email - Email of the group. 219 pageToken: string, Token to specify next page in the list 220 query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups 221 sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used 222 Allowed values 223 ASCENDING - Ascending order. 224 DESCENDING - Descending order. 225 userKey: string, Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. 226 x__xgafv: string, V1 error format. 227 Allowed values 228 1 - v1 error format 229 2 - v2 error format 230 231Returns: 232 An object of the form: 233 234 { 235 "etag": "A String", # ETag of the resource. 236 "groups": [ # List of group objects. 237 { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 238 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 239 "aliases": [ # List of a group's alias email addresses. 240 "A String", 241 ], 242 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 243 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 244 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 245 "etag": "A String", # ETag of the resource. 246 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 247 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 248 "name": "A String", # The group's display name. 249 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 250 "A String", 251 ], 252 }, 253 ], 254 "kind": "admin#directory#groups", # Kind of resource this is. 255 "nextPageToken": "A String", # Token used to access next page of this result. 256}</pre> 257</div> 258 259<div class="method"> 260 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 261 <pre>Retrieves the next page of results. 262 263Args: 264 previous_request: The request for the previous page. (required) 265 previous_response: The response from the request for the previous page. (required) 266 267Returns: 268 A request object that you can call 'execute()' on to request the next 269 page. Returns None if there are no more items in the collection. 270 </pre> 271</div> 272 273<div class="method"> 274 <code class="details" id="patch">patch(groupKey, body=None, x__xgafv=None)</code> 275 <pre>Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch). 276 277Args: 278 groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required) 279 body: object, The request body. 280 The object takes the form of: 281 282{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 283 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 284 "aliases": [ # List of a group's alias email addresses. 285 "A String", 286 ], 287 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 288 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 289 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 290 "etag": "A String", # ETag of the resource. 291 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 292 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 293 "name": "A String", # The group's display name. 294 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 295 "A String", 296 ], 297} 298 299 x__xgafv: string, V1 error format. 300 Allowed values 301 1 - v1 error format 302 2 - v2 error format 303 304Returns: 305 An object of the form: 306 307 { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 308 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 309 "aliases": [ # List of a group's alias email addresses. 310 "A String", 311 ], 312 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 313 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 314 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 315 "etag": "A String", # ETag of the resource. 316 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 317 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 318 "name": "A String", # The group's display name. 319 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 320 "A String", 321 ], 322}</pre> 323</div> 324 325<div class="method"> 326 <code class="details" id="update">update(groupKey, body=None, x__xgafv=None)</code> 327 <pre>Updates a group's properties. 328 329Args: 330 groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required) 331 body: object, The request body. 332 The object takes the form of: 333 334{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 335 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 336 "aliases": [ # List of a group's alias email addresses. 337 "A String", 338 ], 339 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 340 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 341 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 342 "etag": "A String", # ETag of the resource. 343 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 344 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 345 "name": "A String", # The group's display name. 346 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 347 "A String", 348 ], 349} 350 351 x__xgafv: string, V1 error format. 352 Allowed values 353 1 - v1 error format 354 2 - v2 error format 355 356Returns: 357 An object of the form: 358 359 { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups). 360 "adminCreated": True or False, # Value is `true` if this group was created by an administrator rather than a user. 361 "aliases": [ # List of a group's alias email addresses. 362 "A String", 363 ], 364 "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. 365 "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. 366 "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. 367 "etag": "A String", # ETag of the resource. 368 "id": "A String", # The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. 369 "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`. 370 "name": "A String", # The group's display name. 371 "nonEditableAliases": [ # List of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service. 372 "A String", 373 ], 374}</pre> 375</div> 376 377</body></html>