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