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.roleAssignments.html">roleAssignments</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(customer, roleAssignmentId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a role assignment.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(customer, roleAssignmentId, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a role assignment.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(customer, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Creates a role assignment.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(customer, maxResults=None, pageToken=None, roleId=None, userKey=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a paginated list of all roleAssignments.</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<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="delete">delete(customer, roleAssignmentId, x__xgafv=None)</code> 103 <pre>Deletes a role assignment. 104 105Args: 106 customer: string, Immutable ID of the Google Workspace account. (required) 107 roleAssignmentId: string, Immutable ID of the role assignment. (required) 108 x__xgafv: string, V1 error format. 109 Allowed values 110 1 - v1 error format 111 2 - v2 error format 112</pre> 113</div> 114 115<div class="method"> 116 <code class="details" id="get">get(customer, roleAssignmentId, x__xgafv=None)</code> 117 <pre>Retrieves a role assignment. 118 119Args: 120 customer: string, Immutable ID of the Google Workspace account. (required) 121 roleAssignmentId: string, Immutable ID of the role assignment. (required) 122 x__xgafv: string, V1 error format. 123 Allowed values 124 1 - v1 error format 125 2 - v2 error format 126 127Returns: 128 An object of the form: 129 130 { # Defines an assignment of a role. 131 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 132 "etag": "A String", # ETag of the resource. 133 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. 134 "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. 135 "roleAssignmentId": "A String", # ID of this roleAssignment. 136 "roleId": "A String", # The ID of the role that is assigned. 137 "scopeType": "A String", # The scope in which this role is assigned. 138}</pre> 139</div> 140 141<div class="method"> 142 <code class="details" id="insert">insert(customer, body=None, x__xgafv=None)</code> 143 <pre>Creates a role assignment. 144 145Args: 146 customer: string, Immutable ID of the Google Workspace account. (required) 147 body: object, The request body. 148 The object takes the form of: 149 150{ # Defines an assignment of a role. 151 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 152 "etag": "A String", # ETag of the resource. 153 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. 154 "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. 155 "roleAssignmentId": "A String", # ID of this roleAssignment. 156 "roleId": "A String", # The ID of the role that is assigned. 157 "scopeType": "A String", # The scope in which this role is assigned. 158} 159 160 x__xgafv: string, V1 error format. 161 Allowed values 162 1 - v1 error format 163 2 - v2 error format 164 165Returns: 166 An object of the form: 167 168 { # Defines an assignment of a role. 169 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 170 "etag": "A String", # ETag of the resource. 171 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. 172 "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. 173 "roleAssignmentId": "A String", # ID of this roleAssignment. 174 "roleId": "A String", # The ID of the role that is assigned. 175 "scopeType": "A String", # The scope in which this role is assigned. 176}</pre> 177</div> 178 179<div class="method"> 180 <code class="details" id="list">list(customer, maxResults=None, pageToken=None, roleId=None, userKey=None, x__xgafv=None)</code> 181 <pre>Retrieves a paginated list of all roleAssignments. 182 183Args: 184 customer: string, Immutable ID of the Google Workspace account. (required) 185 maxResults: integer, Maximum number of results to return. 186 pageToken: string, Token to specify the next page in the list. 187 roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID. 188 userKey: string, The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user. 189 x__xgafv: string, V1 error format. 190 Allowed values 191 1 - v1 error format 192 2 - v2 error format 193 194Returns: 195 An object of the form: 196 197 { 198 "etag": "A String", # ETag of the resource. 199 "items": [ # A list of RoleAssignment resources. 200 { # Defines an assignment of a role. 201 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 202 "etag": "A String", # ETag of the resource. 203 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`. 204 "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to. 205 "roleAssignmentId": "A String", # ID of this roleAssignment. 206 "roleId": "A String", # The ID of the role that is assigned. 207 "scopeType": "A String", # The scope in which this role is assigned. 208 }, 209 ], 210 "kind": "admin#directory#roleAssignments", # The type of the API resource. This is always `admin#directory#roleAssignments`. 211 "nextPageToken": "A String", 212}</pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 217 <pre>Retrieves the next page of results. 218 219Args: 220 previous_request: The request for the previous page. (required) 221 previous_response: The response from the request for the previous page. (required) 222 223Returns: 224 A request object that you can call 'execute()' on to request the next 225 page. Returns None if there are no more items in the collection. 226 </pre> 227</div> 228 229</body></html>