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> . <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="#delete">delete(groupKey, alias)</a></code></p>
     79 <p class="firstline">Remove a alias for the group</p>
     80 <p class="toc_element">
     81   <code><a href="#insert">insert(groupKey, body)</a></code></p>
     82 <p class="firstline">Add a alias for the group</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(groupKey)</a></code></p>
     85 <p class="firstline">List all aliases for a group</p>
     86 <h3>Method Details</h3>
     87 <div class="method">
     88     <code class="details" id="delete">delete(groupKey, alias)</code>
     89   <pre>Remove a alias for the group
     90 
     91 Args:
     92   groupKey: string, Email or immutable Id of the group (required)
     93   alias: string, The alias to be removed (required)
     94 </pre>
     95 </div>
     96 
     97 <div class="method">
     98     <code class="details" id="insert">insert(groupKey, body)</code>
     99   <pre>Add a alias for the group
    100 
    101 Args:
    102   groupKey: string, Email or immutable Id of the group (required)
    103   body: object, The request body. (required)
    104     The object takes the form of:
    105 
    106 { # JSON template for Alias object in Directory API.
    107     "alias": "A String", # A alias email
    108     "kind": "admin#directory#alias", # Kind of resource this is.
    109     "etag": "A String", # ETag of the resource.
    110     "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
    111     "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
    112   }
    113 
    114 
    115 Returns:
    116   An object of the form:
    117 
    118     { # JSON template for Alias object in Directory API.
    119       "alias": "A String", # A alias email
    120       "kind": "admin#directory#alias", # Kind of resource this is.
    121       "etag": "A String", # ETag of the resource.
    122       "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
    123       "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
    124     }</pre>
    125 </div>
    126 
    127 <div class="method">
    128     <code class="details" id="list">list(groupKey)</code>
    129   <pre>List all aliases for a group
    130 
    131 Args:
    132   groupKey: string, Email or immutable Id of the group (required)
    133 
    134 Returns:
    135   An object of the form:
    136 
    137     { # JSON response template to list aliases in Directory API.
    138     "kind": "admin#directory#aliases", # Kind of resource this is.
    139     "etag": "A String", # ETag of the resource.
    140     "aliases": [ # List of alias objects.
    141       "",
    142     ],
    143   }</pre>
    144 </div>
    145 
    146 </body></html>