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.roles.html">roles</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, roleId, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes a role.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(customer, roleId, x__xgafv=None)</a></code></p> 85<p class="firstline">Retrieves a role.</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.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(customer, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a paginated list of all the roles in a domain.</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(customer, roleId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Patches a role.</p> 98<p class="toc_element"> 99 <code><a href="#update">update(customer, roleId, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates a role.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(customer, roleId, x__xgafv=None)</code> 109 <pre>Deletes a role. 110 111Args: 112 customer: string, Immutable ID of the Google Workspace account. (required) 113 roleId: string, Immutable ID of the role. (required) 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118</pre> 119</div> 120 121<div class="method"> 122 <code class="details" id="get">get(customer, roleId, x__xgafv=None)</code> 123 <pre>Retrieves a role. 124 125Args: 126 customer: string, Immutable ID of the Google Workspace account. (required) 127 roleId: string, Immutable ID of the role. (required) 128 x__xgafv: string, V1 error format. 129 Allowed values 130 1 - v1 error format 131 2 - v2 error format 132 133Returns: 134 An object of the form: 135 136 { 137 "etag": "A String", # ETag of the resource. 138 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 139 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 140 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 141 "roleDescription": "A String", # A short description of the role. 142 "roleId": "A String", # ID of the role. 143 "roleName": "A String", # Name of the role. 144 "rolePrivileges": [ # The set of privileges that are granted to this role. 145 { 146 "privilegeName": "A String", # The name of the privilege. 147 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 148 }, 149 ], 150}</pre> 151</div> 152 153<div class="method"> 154 <code class="details" id="insert">insert(customer, body=None, x__xgafv=None)</code> 155 <pre>Creates a role. 156 157Args: 158 customer: string, Immutable ID of the Google Workspace account. (required) 159 body: object, The request body. 160 The object takes the form of: 161 162{ 163 "etag": "A String", # ETag of the resource. 164 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 165 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 166 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 167 "roleDescription": "A String", # A short description of the role. 168 "roleId": "A String", # ID of the role. 169 "roleName": "A String", # Name of the role. 170 "rolePrivileges": [ # The set of privileges that are granted to this role. 171 { 172 "privilegeName": "A String", # The name of the privilege. 173 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 174 }, 175 ], 176} 177 178 x__xgafv: string, V1 error format. 179 Allowed values 180 1 - v1 error format 181 2 - v2 error format 182 183Returns: 184 An object of the form: 185 186 { 187 "etag": "A String", # ETag of the resource. 188 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 189 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 190 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 191 "roleDescription": "A String", # A short description of the role. 192 "roleId": "A String", # ID of the role. 193 "roleName": "A String", # Name of the role. 194 "rolePrivileges": [ # The set of privileges that are granted to this role. 195 { 196 "privilegeName": "A String", # The name of the privilege. 197 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 198 }, 199 ], 200}</pre> 201</div> 202 203<div class="method"> 204 <code class="details" id="list">list(customer, maxResults=None, pageToken=None, x__xgafv=None)</code> 205 <pre>Retrieves a paginated list of all the roles in a domain. 206 207Args: 208 customer: string, Immutable ID of the Google Workspace account. (required) 209 maxResults: integer, Maximum number of results to return. 210 pageToken: string, Token to specify the next page in the list. 211 x__xgafv: string, V1 error format. 212 Allowed values 213 1 - v1 error format 214 2 - v2 error format 215 216Returns: 217 An object of the form: 218 219 { 220 "etag": "A String", # ETag of the resource. 221 "items": [ # A list of Role resources. 222 { 223 "etag": "A String", # ETag of the resource. 224 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 225 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 226 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 227 "roleDescription": "A String", # A short description of the role. 228 "roleId": "A String", # ID of the role. 229 "roleName": "A String", # Name of the role. 230 "rolePrivileges": [ # The set of privileges that are granted to this role. 231 { 232 "privilegeName": "A String", # The name of the privilege. 233 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 234 }, 235 ], 236 }, 237 ], 238 "kind": "admin#directory#roles", # The type of the API resource. This is always `admin#directory#roles`. 239 "nextPageToken": "A String", 240}</pre> 241</div> 242 243<div class="method"> 244 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 245 <pre>Retrieves the next page of results. 246 247Args: 248 previous_request: The request for the previous page. (required) 249 previous_response: The response from the request for the previous page. (required) 250 251Returns: 252 A request object that you can call 'execute()' on to request the next 253 page. Returns None if there are no more items in the collection. 254 </pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="patch">patch(customer, roleId, body=None, x__xgafv=None)</code> 259 <pre>Patches a role. 260 261Args: 262 customer: string, Immutable ID of the Google Workspace account. (required) 263 roleId: string, Immutable ID of the role. (required) 264 body: object, The request body. 265 The object takes the form of: 266 267{ 268 "etag": "A String", # ETag of the resource. 269 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 270 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 271 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 272 "roleDescription": "A String", # A short description of the role. 273 "roleId": "A String", # ID of the role. 274 "roleName": "A String", # Name of the role. 275 "rolePrivileges": [ # The set of privileges that are granted to this role. 276 { 277 "privilegeName": "A String", # The name of the privilege. 278 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 279 }, 280 ], 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 { 292 "etag": "A String", # ETag of the resource. 293 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 294 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 295 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 296 "roleDescription": "A String", # A short description of the role. 297 "roleId": "A String", # ID of the role. 298 "roleName": "A String", # Name of the role. 299 "rolePrivileges": [ # The set of privileges that are granted to this role. 300 { 301 "privilegeName": "A String", # The name of the privilege. 302 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 303 }, 304 ], 305}</pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="update">update(customer, roleId, body=None, x__xgafv=None)</code> 310 <pre>Updates a role. 311 312Args: 313 customer: string, Immutable ID of the Google Workspace account. (required) 314 roleId: string, Immutable ID of the role. (required) 315 body: object, The request body. 316 The object takes the form of: 317 318{ 319 "etag": "A String", # ETag of the resource. 320 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 321 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 322 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 323 "roleDescription": "A String", # A short description of the role. 324 "roleId": "A String", # ID of the role. 325 "roleName": "A String", # Name of the role. 326 "rolePrivileges": [ # The set of privileges that are granted to this role. 327 { 328 "privilegeName": "A String", # The name of the privilege. 329 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 330 }, 331 ], 332} 333 334 x__xgafv: string, V1 error format. 335 Allowed values 336 1 - v1 error format 337 2 - v2 error format 338 339Returns: 340 An object of the form: 341 342 { 343 "etag": "A String", # ETag of the resource. 344 "isSuperAdminRole": True or False, # Returns `true` if the role is a super admin role. 345 "isSystemRole": True or False, # Returns `true` if this is a pre-defined system role. 346 "kind": "admin#directory#role", # The type of the API resource. This is always `admin#directory#role`. 347 "roleDescription": "A String", # A short description of the role. 348 "roleId": "A String", # ID of the role. 349 "roleName": "A String", # Name of the role. 350 "rolePrivileges": [ # The set of privileges that are granted to this role. 351 { 352 "privilegeName": "A String", # The name of the privilege. 353 "serviceId": "A String", # The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](/admin-sdk/directory/v1/reference/privileges/list). 354 }, 355 ], 356}</pre> 357</div> 358 359</body></html>