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 Directory API</a> . <a href="admin_directory_v1.members.html">members</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#delete">delete(groupKey, memberKey)</a></code></p> 79<p class="firstline">Remove membership.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(groupKey, memberKey)</a></code></p> 82<p class="firstline">Retrieve Group Member</p> 83<p class="toc_element"> 84 <code><a href="#hasMember">hasMember(groupKey, memberKey)</a></code></p> 85<p class="firstline">Checks whether the given user is a member of the group. Membership can be direct or nested.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(groupKey, body)</a></code></p> 88<p class="firstline">Add user to the specified group.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(groupKey, pageToken=None, maxResults=None, roles=None, includeDerivedMembership=None)</a></code></p> 91<p class="firstline">Retrieve all members in a group (paginated)</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(groupKey, memberKey, body)</a></code></p> 97<p class="firstline">Update membership of a user in the specified group. This method supports patch semantics.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(groupKey, memberKey, body)</a></code></p> 100<p class="firstline">Update membership of a user in the specified group.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="delete">delete(groupKey, memberKey)</code> 104 <pre>Remove membership. 105 106Args: 107 groupKey: string, Email or immutable ID of the group (required) 108 memberKey: string, Email or immutable ID of the member (required) 109</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="get">get(groupKey, memberKey)</code> 114 <pre>Retrieve Group Member 115 116Args: 117 groupKey: string, Email or immutable ID of the group (required) 118 memberKey: string, Email or immutable ID of the member (required) 119 120Returns: 121 An object of the form: 122 123 { # JSON template for Member resource in Directory API. 124 "status": "A String", # Status of member (Immutable) 125 "kind": "admin#directory#member", # Kind of resource this is. 126 "delivery_settings": "A String", # Delivery settings of member 127 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 128 "etag": "A String", # ETag of the resource. 129 "role": "A String", # Role of member 130 "type": "A String", # Type of member (Immutable) 131 "email": "A String", # Email of member (Read-only) 132 }</pre> 133</div> 134 135<div class="method"> 136 <code class="details" id="hasMember">hasMember(groupKey, memberKey)</code> 137 <pre>Checks whether the given user is a member of the group. Membership can be direct or nested. 138 139Args: 140 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) 141 memberKey: string, Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID. (required) 142 143Returns: 144 An object of the form: 145 146 { # JSON template for Has Member response in Directory API. 147 "isMember": True or False, # Identifies whether the given user is a member of the group. Membership can be direct or nested. 148 }</pre> 149</div> 150 151<div class="method"> 152 <code class="details" id="insert">insert(groupKey, body)</code> 153 <pre>Add user to the specified group. 154 155Args: 156 groupKey: string, Email or immutable ID of the group (required) 157 body: object, The request body. (required) 158 The object takes the form of: 159 160{ # JSON template for Member resource in Directory API. 161 "status": "A String", # Status of member (Immutable) 162 "kind": "admin#directory#member", # Kind of resource this is. 163 "delivery_settings": "A String", # Delivery settings of member 164 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 165 "etag": "A String", # ETag of the resource. 166 "role": "A String", # Role of member 167 "type": "A String", # Type of member (Immutable) 168 "email": "A String", # Email of member (Read-only) 169 } 170 171 172Returns: 173 An object of the form: 174 175 { # JSON template for Member resource in Directory API. 176 "status": "A String", # Status of member (Immutable) 177 "kind": "admin#directory#member", # Kind of resource this is. 178 "delivery_settings": "A String", # Delivery settings of member 179 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 180 "etag": "A String", # ETag of the resource. 181 "role": "A String", # Role of member 182 "type": "A String", # Type of member (Immutable) 183 "email": "A String", # Email of member (Read-only) 184 }</pre> 185</div> 186 187<div class="method"> 188 <code class="details" id="list">list(groupKey, pageToken=None, maxResults=None, roles=None, includeDerivedMembership=None)</code> 189 <pre>Retrieve all members in a group (paginated) 190 191Args: 192 groupKey: string, Email or immutable ID of the group (required) 193 pageToken: string, Token to specify next page in the list 194 maxResults: integer, Maximum number of results to return. Default is 200 195 roles: string, Comma separated role values to filter list results on. 196 includeDerivedMembership: boolean, Whether to list indirect memberships. Default: false. 197 198Returns: 199 An object of the form: 200 201 { # JSON response template for List Members operation in Directory API. 202 "nextPageToken": "A String", # Token used to access next page of this result. 203 "kind": "admin#directory#members", # Kind of resource this is. 204 "etag": "A String", # ETag of the resource. 205 "members": [ # List of member objects. 206 { # JSON template for Member resource in Directory API. 207 "status": "A String", # Status of member (Immutable) 208 "kind": "admin#directory#member", # Kind of resource this is. 209 "delivery_settings": "A String", # Delivery settings of member 210 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 211 "etag": "A String", # ETag of the resource. 212 "role": "A String", # Role of member 213 "type": "A String", # Type of member (Immutable) 214 "email": "A String", # Email of member (Read-only) 215 }, 216 ], 217 }</pre> 218</div> 219 220<div class="method"> 221 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 222 <pre>Retrieves the next page of results. 223 224Args: 225 previous_request: The request for the previous page. (required) 226 previous_response: The response from the request for the previous page. (required) 227 228Returns: 229 A request object that you can call 'execute()' on to request the next 230 page. Returns None if there are no more items in the collection. 231 </pre> 232</div> 233 234<div class="method"> 235 <code class="details" id="patch">patch(groupKey, memberKey, body)</code> 236 <pre>Update membership of a user in the specified group. This method supports patch semantics. 237 238Args: 239 groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required) 240 memberKey: string, Email or immutable ID of the user. If ID, it should match with id of member object (required) 241 body: object, The request body. (required) 242 The object takes the form of: 243 244{ # JSON template for Member resource in Directory API. 245 "status": "A String", # Status of member (Immutable) 246 "kind": "admin#directory#member", # Kind of resource this is. 247 "delivery_settings": "A String", # Delivery settings of member 248 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 249 "etag": "A String", # ETag of the resource. 250 "role": "A String", # Role of member 251 "type": "A String", # Type of member (Immutable) 252 "email": "A String", # Email of member (Read-only) 253 } 254 255 256Returns: 257 An object of the form: 258 259 { # JSON template for Member resource in Directory API. 260 "status": "A String", # Status of member (Immutable) 261 "kind": "admin#directory#member", # Kind of resource this is. 262 "delivery_settings": "A String", # Delivery settings of member 263 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 264 "etag": "A String", # ETag of the resource. 265 "role": "A String", # Role of member 266 "type": "A String", # Type of member (Immutable) 267 "email": "A String", # Email of member (Read-only) 268 }</pre> 269</div> 270 271<div class="method"> 272 <code class="details" id="update">update(groupKey, memberKey, body)</code> 273 <pre>Update membership of a user in the specified group. 274 275Args: 276 groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required) 277 memberKey: string, Email or immutable ID of the user. If ID, it should match with id of member object (required) 278 body: object, The request body. (required) 279 The object takes the form of: 280 281{ # JSON template for Member resource in Directory API. 282 "status": "A String", # Status of member (Immutable) 283 "kind": "admin#directory#member", # Kind of resource this is. 284 "delivery_settings": "A String", # Delivery settings of member 285 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 286 "etag": "A String", # ETag of the resource. 287 "role": "A String", # Role of member 288 "type": "A String", # Type of member (Immutable) 289 "email": "A String", # Email of member (Read-only) 290 } 291 292 293Returns: 294 An object of the form: 295 296 { # JSON template for Member resource in Directory API. 297 "status": "A String", # Status of member (Immutable) 298 "kind": "admin#directory#member", # Kind of resource this is. 299 "delivery_settings": "A String", # Delivery settings of member 300 "id": "A String", # Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only) 301 "etag": "A String", # ETag of the resource. 302 "role": "A String", # Role of member 303 "type": "A String", # Type of member (Immutable) 304 "email": "A String", # Email of member (Read-only) 305 }</pre> 306</div> 307 308</body></html>