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.members.html">members</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, memberKey, x__xgafv=None)</a></code></p> 82<p class="firstline">Removes a member from a group.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(groupKey, memberKey, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a group member's properties.</p> 86<p class="toc_element"> 87 <code><a href="#hasMember">hasMember(groupKey, memberKey, x__xgafv=None)</a></code></p> 88<p class="firstline">Checks whether the given user is a member of the group. Membership can be direct or nested.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(groupKey, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Adds a user to the specified group.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Retrieves a paginated list of all members in a group.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(groupKey, memberKey, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).</p> 101<p class="toc_element"> 102 <code><a href="#update">update(groupKey, memberKey, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates the membership of a user in the specified group.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="delete">delete(groupKey, memberKey, x__xgafv=None)</code> 112 <pre>Removes a member from a group. 113 114Args: 115 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) 116 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. (required) 117 x__xgafv: string, V1 error format. 118 Allowed values 119 1 - v1 error format 120 2 - v2 error format 121</pre> 122</div> 123 124<div class="method"> 125 <code class="details" id="get">get(groupKey, memberKey, x__xgafv=None)</code> 126 <pre>Retrieves a group member's properties. 127 128Args: 129 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) 130 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique 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 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 140 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 141 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 142 "etag": "A String", # ETag of the resource. 143 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 144 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 145 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 146 "status": "A String", # Status of member (Immutable) 147 "type": "A String", # The type of group member. 148}</pre> 149</div> 150 151<div class="method"> 152 <code class="details" id="hasMember">hasMember(groupKey, memberKey, x__xgafv=None)</code> 153 <pre>Checks whether the given user is a member of the group. Membership can be direct or nested. 154 155Args: 156 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) 157 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) 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # JSON template for Has Member response in Directory API. 167 "isMember": True or False, # Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested. 168}</pre> 169</div> 170 171<div class="method"> 172 <code class="details" id="insert">insert(groupKey, body=None, x__xgafv=None)</code> 173 <pre>Adds a user to the specified group. 174 175Args: 176 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) 177 body: object, The request body. 178 The object takes the form of: 179 180{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 181 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 182 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 183 "etag": "A String", # ETag of the resource. 184 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 185 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 186 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 187 "status": "A String", # Status of member (Immutable) 188 "type": "A String", # The type of group member. 189} 190 191 x__xgafv: string, V1 error format. 192 Allowed values 193 1 - v1 error format 194 2 - v2 error format 195 196Returns: 197 An object of the form: 198 199 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 200 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 201 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 202 "etag": "A String", # ETag of the resource. 203 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 204 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 205 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 206 "status": "A String", # Status of member (Immutable) 207 "type": "A String", # The type of group member. 208}</pre> 209</div> 210 211<div class="method"> 212 <code class="details" id="list">list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)</code> 213 <pre>Retrieves a paginated list of all members in a group. 214 215Args: 216 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) 217 includeDerivedMembership: boolean, Whether to list indirect memberships. Default: false. 218 maxResults: integer, Maximum number of results to return. Max allowed value is 200. 219 pageToken: string, Token to specify next page in the list. 220 roles: string, The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`. 221 x__xgafv: string, V1 error format. 222 Allowed values 223 1 - v1 error format 224 2 - v2 error format 225 226Returns: 227 An object of the form: 228 229 { 230 "etag": "A String", # ETag of the resource. 231 "kind": "admin#directory#members", # Kind of resource this is. 232 "members": [ # List of member objects. 233 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 234 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 235 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 236 "etag": "A String", # ETag of the resource. 237 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 238 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 239 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 240 "status": "A String", # Status of member (Immutable) 241 "type": "A String", # The type of group member. 242 }, 243 ], 244 "nextPageToken": "A String", # Token used to access next page of this result. 245}</pre> 246</div> 247 248<div class="method"> 249 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 250 <pre>Retrieves the next page of results. 251 252Args: 253 previous_request: The request for the previous page. (required) 254 previous_response: The response from the request for the previous page. (required) 255 256Returns: 257 A request object that you can call 'execute()' on to request the next 258 page. Returns None if there are no more items in the collection. 259 </pre> 260</div> 261 262<div class="method"> 263 <code class="details" id="patch">patch(groupKey, memberKey, body=None, x__xgafv=None)</code> 264 <pre>Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch). 265 266Args: 267 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) 268 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. (required) 269 body: object, The request body. 270 The object takes the form of: 271 272{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 273 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 274 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 275 "etag": "A String", # ETag of the resource. 276 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 277 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 278 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 279 "status": "A String", # Status of member (Immutable) 280 "type": "A String", # The type of group member. 281} 282 283 x__xgafv: string, V1 error format. 284 Allowed values 285 1 - v1 error format 286 2 - v2 error format 287 288Returns: 289 An object of the form: 290 291 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 292 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 293 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 294 "etag": "A String", # ETag of the resource. 295 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 296 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 297 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 298 "status": "A String", # Status of member (Immutable) 299 "type": "A String", # The type of group member. 300}</pre> 301</div> 302 303<div class="method"> 304 <code class="details" id="update">update(groupKey, memberKey, body=None, x__xgafv=None)</code> 305 <pre>Updates the membership of a user in the specified group. 306 307Args: 308 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) 309 memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. (required) 310 body: object, The request body. 311 The object takes the form of: 312 313{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 314 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 315 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 316 "etag": "A String", # ETag of the resource. 317 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 318 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 319 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 320 "status": "A String", # Status of member (Immutable) 321 "type": "A String", # The type of group member. 322} 323 324 x__xgafv: string, V1 error format. 325 Allowed values 326 1 - v1 error format 327 2 - v2 error format 328 329Returns: 330 An object of the form: 331 332 { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members). 333 "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get. 334 "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes. 335 "etag": "A String", # ETag of the resource. 336 "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`. 337 "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`. 338 "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094). 339 "status": "A String", # Status of member (Immutable) 340 "type": "A String", # The type of group member. 341}</pre> 342</div> 343 344</body></html>