Home | History | Annotate | Download | only in dyn 
      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 Directory 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="#delete">delete(groupKey)</a></code></p>
     84 <p class="firstline">Delete Group</p>
     85 <p class="toc_element">
     86   <code><a href="#get">get(groupKey)</a></code></p>
     87 <p class="firstline">Retrieve Group</p>
     88 <p class="toc_element">
     89   <code><a href="#insert">insert(body)</a></code></p>
     90 <p class="firstline">Create Group</p>
     91 <p class="toc_element">
     92   <code><a href="#list">list(customer=None, domain=None, pageToken=None, maxResults=None, userKey=None)</a></code></p>
     93 <p class="firstline">Retrieve all groups in a domain (paginated)</p>
     94 <p class="toc_element">
     95   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     96 <p class="firstline">Retrieves the next page of results.</p>
     97 <p class="toc_element">
     98   <code><a href="#patch">patch(groupKey, body)</a></code></p>
     99 <p class="firstline">Update Group. This method supports patch semantics.</p>
    100 <p class="toc_element">
    101   <code><a href="#update">update(groupKey, body)</a></code></p>
    102 <p class="firstline">Update Group</p>
    103 <h3>Method Details</h3>
    104 <div class="method">
    105     <code class="details" id="delete">delete(groupKey)</code>
    106   <pre>Delete Group
    107 
    108 Args:
    109   groupKey: string, Email or immutable Id of the group (required)
    110 </pre>
    111 </div>
    112 
    113 <div class="method">
    114     <code class="details" id="get">get(groupKey)</code>
    115   <pre>Retrieve Group
    116 
    117 Args:
    118   groupKey: string, Email or immutable Id of the group (required)
    119 
    120 Returns:
    121   An object of the form:
    122 
    123     { # JSON template for Group resource in Directory API.
    124       "nonEditableAliases": [ # List of non editable aliases (Read-only)
    125         "A String",
    126       ],
    127       "kind": "admin#directory#group", # Kind of resource this is.
    128       "description": "A String", # Description of the group
    129       "name": "A String", # Group name
    130       "adminCreated": True or False, # Is the group created by admin (Read-only) *
    131       "directMembersCount": "A String", # Group direct members count
    132       "id": "A String", # Unique identifier of Group (Read-only)
    133       "etag": "A String", # ETag of the resource.
    134       "email": "A String", # Email of Group
    135       "aliases": [ # List of aliases (Read-only)
    136         "A String",
    137       ],
    138     }</pre>
    139 </div>
    140 
    141 <div class="method">
    142     <code class="details" id="insert">insert(body)</code>
    143   <pre>Create Group
    144 
    145 Args:
    146   body: object, The request body. (required)
    147     The object takes the form of:
    148 
    149 { # JSON template for Group resource in Directory API.
    150     "nonEditableAliases": [ # List of non editable aliases (Read-only)
    151       "A String",
    152     ],
    153     "kind": "admin#directory#group", # Kind of resource this is.
    154     "description": "A String", # Description of the group
    155     "name": "A String", # Group name
    156     "adminCreated": True or False, # Is the group created by admin (Read-only) *
    157     "directMembersCount": "A String", # Group direct members count
    158     "id": "A String", # Unique identifier of Group (Read-only)
    159     "etag": "A String", # ETag of the resource.
    160     "email": "A String", # Email of Group
    161     "aliases": [ # List of aliases (Read-only)
    162       "A String",
    163     ],
    164   }
    165 
    166 
    167 Returns:
    168   An object of the form:
    169 
    170     { # JSON template for Group resource in Directory API.
    171       "nonEditableAliases": [ # List of non editable aliases (Read-only)
    172         "A String",
    173       ],
    174       "kind": "admin#directory#group", # Kind of resource this is.
    175       "description": "A String", # Description of the group
    176       "name": "A String", # Group name
    177       "adminCreated": True or False, # Is the group created by admin (Read-only) *
    178       "directMembersCount": "A String", # Group direct members count
    179       "id": "A String", # Unique identifier of Group (Read-only)
    180       "etag": "A String", # ETag of the resource.
    181       "email": "A String", # Email of Group
    182       "aliases": [ # List of aliases (Read-only)
    183         "A String",
    184       ],
    185     }</pre>
    186 </div>
    187 
    188 <div class="method">
    189     <code class="details" id="list">list(customer=None, domain=None, pageToken=None, maxResults=None, userKey=None)</code>
    190   <pre>Retrieve all groups in a domain (paginated)
    191 
    192 Args:
    193   customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
    194   domain: string, Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
    195   pageToken: string, Token to specify next page in the list
    196   maxResults: integer, Maximum number of results to return. Default is 200
    197   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 Id, it should match with id of user object
    198 
    199 Returns:
    200   An object of the form:
    201 
    202     { # JSON response template for List Groups operation in Directory API.
    203     "nextPageToken": "A String", # Token used to access next page of this result.
    204     "kind": "admin#directory#groups", # Kind of resource this is.
    205     "etag": "A String", # ETag of the resource.
    206     "groups": [ # List of group objects.
    207       { # JSON template for Group resource in Directory API.
    208           "nonEditableAliases": [ # List of non editable aliases (Read-only)
    209             "A String",
    210           ],
    211           "kind": "admin#directory#group", # Kind of resource this is.
    212           "description": "A String", # Description of the group
    213           "name": "A String", # Group name
    214           "adminCreated": True or False, # Is the group created by admin (Read-only) *
    215           "directMembersCount": "A String", # Group direct members count
    216           "id": "A String", # Unique identifier of Group (Read-only)
    217           "etag": "A String", # ETag of the resource.
    218           "email": "A String", # Email of Group
    219           "aliases": [ # List of aliases (Read-only)
    220             "A String",
    221           ],
    222         },
    223     ],
    224   }</pre>
    225 </div>
    226 
    227 <div class="method">
    228     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    229   <pre>Retrieves the next page of results.
    230 
    231 Args:
    232   previous_request: The request for the previous page. (required)
    233   previous_response: The response from the request for the previous page. (required)
    234 
    235 Returns:
    236   A request object that you can call 'execute()' on to request the next
    237   page. Returns None if there are no more items in the collection.
    238     </pre>
    239 </div>
    240 
    241 <div class="method">
    242     <code class="details" id="patch">patch(groupKey, body)</code>
    243   <pre>Update Group. This method supports patch semantics.
    244 
    245 Args:
    246   groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
    247   body: object, The request body. (required)
    248     The object takes the form of:
    249 
    250 { # JSON template for Group resource in Directory API.
    251     "nonEditableAliases": [ # List of non editable aliases (Read-only)
    252       "A String",
    253     ],
    254     "kind": "admin#directory#group", # Kind of resource this is.
    255     "description": "A String", # Description of the group
    256     "name": "A String", # Group name
    257     "adminCreated": True or False, # Is the group created by admin (Read-only) *
    258     "directMembersCount": "A String", # Group direct members count
    259     "id": "A String", # Unique identifier of Group (Read-only)
    260     "etag": "A String", # ETag of the resource.
    261     "email": "A String", # Email of Group
    262     "aliases": [ # List of aliases (Read-only)
    263       "A String",
    264     ],
    265   }
    266 
    267 
    268 Returns:
    269   An object of the form:
    270 
    271     { # JSON template for Group resource in Directory API.
    272       "nonEditableAliases": [ # List of non editable aliases (Read-only)
    273         "A String",
    274       ],
    275       "kind": "admin#directory#group", # Kind of resource this is.
    276       "description": "A String", # Description of the group
    277       "name": "A String", # Group name
    278       "adminCreated": True or False, # Is the group created by admin (Read-only) *
    279       "directMembersCount": "A String", # Group direct members count
    280       "id": "A String", # Unique identifier of Group (Read-only)
    281       "etag": "A String", # ETag of the resource.
    282       "email": "A String", # Email of Group
    283       "aliases": [ # List of aliases (Read-only)
    284         "A String",
    285       ],
    286     }</pre>
    287 </div>
    288 
    289 <div class="method">
    290     <code class="details" id="update">update(groupKey, body)</code>
    291   <pre>Update Group
    292 
    293 Args:
    294   groupKey: string, Email or immutable Id of the group. If Id, it should match with id of group object (required)
    295   body: object, The request body. (required)
    296     The object takes the form of:
    297 
    298 { # JSON template for Group resource in Directory API.
    299     "nonEditableAliases": [ # List of non editable aliases (Read-only)
    300       "A String",
    301     ],
    302     "kind": "admin#directory#group", # Kind of resource this is.
    303     "description": "A String", # Description of the group
    304     "name": "A String", # Group name
    305     "adminCreated": True or False, # Is the group created by admin (Read-only) *
    306     "directMembersCount": "A String", # Group direct members count
    307     "id": "A String", # Unique identifier of Group (Read-only)
    308     "etag": "A String", # ETag of the resource.
    309     "email": "A String", # Email of Group
    310     "aliases": [ # List of aliases (Read-only)
    311       "A String",
    312     ],
    313   }
    314 
    315 
    316 Returns:
    317   An object of the form:
    318 
    319     { # JSON template for Group resource in Directory API.
    320       "nonEditableAliases": [ # List of non editable aliases (Read-only)
    321         "A String",
    322       ],
    323       "kind": "admin#directory#group", # Kind of resource this is.
    324       "description": "A String", # Description of the group
    325       "name": "A String", # Group name
    326       "adminCreated": True or False, # Is the group created by admin (Read-only) *
    327       "directMembersCount": "A String", # Group direct members count
    328       "id": "A String", # Unique identifier of Group (Read-only)
    329       "etag": "A String", # ETag of the resource.
    330       "email": "A String", # Email of Group
    331       "aliases": [ # List of aliases (Read-only)
    332         "A String",
    333       ],
    334     }</pre>
    335 </div>
    336 
    337 </body></html>