1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.roles.html">roles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(customer, roleId)</a></code></p>
<p class="firstline">Deletes a role.</p>
<p class="toc_element">
<code><a href="#get">get(customer, roleId)</a></code></p>
<p class="firstline">Retrieves a role.</p>
<p class="toc_element">
<code><a href="#insert">insert(customer, body)</a></code></p>
<p class="firstline">Creates a role.</p>
<p class="toc_element">
<code><a href="#list">list(customer, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a paginated list of all the roles in a domain.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(customer, roleId, body)</a></code></p>
<p class="firstline">Updates a role. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(customer, roleId, body)</a></code></p>
<p class="firstline">Updates a role.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(customer, roleId)</code>
<pre>Deletes a role.
Args:
customer: string, Immutable ID of the G Suite account. (required)
roleId: string, Immutable ID of the role. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customer, roleId)</code>
<pre>Retrieves a role.
Args:
customer: string, Immutable ID of the G Suite account. (required)
roleId: string, Immutable ID of the role. (required)
Returns:
An object of the form:
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(customer, body)</code>
<pre>Creates a role.
Args:
customer: string, Immutable ID of the G Suite account. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
}
Returns:
An object of the form:
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
<pre>Retrieves a paginated list of all the roles in a domain.
Args:
customer: string, Immutable ID of the G Suite account. (required)
pageToken: string, Token to specify the next page in the list.
maxResults: integer, Maximum number of results to return.
Returns:
An object of the form:
{ # JSON response template for List roles operation in Directory API.
"nextPageToken": "A String",
"items": [ # A list of Role resources.
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
},
],
"kind": "admin#directory#roles", # The type of the API resource. This is always admin#directory#roles.
"etag": "A String", # ETag of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customer, roleId, body)</code>
<pre>Updates a role. This method supports patch semantics.
Args:
customer: string, Immutable ID of the G Suite account. (required)
roleId: string, Immutable ID of the role. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
}
Returns:
An object of the form:
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customer, roleId, body)</code>
<pre>Updates a role.
Args:
customer: string, Immutable ID of the G Suite account. (required)
roleId: string, Immutable ID of the role. (required)
body: object, The request body. (required)
The object takes the form of:
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
}
Returns:
An object of the form:
{ # JSON template for role resource in Directory API.
"kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
"roleId": "A String", # ID of the role.
"roleDescription": "A String", # A short description of the role.
"etag": "A String", # ETag of the resource.
"isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
"roleName": "A String", # Name of the role.
"isSystemRole": True or False, # Returns true if this is a pre-defined system role.
"rolePrivileges": [ # The set of privileges that are granted to this role.
{
"serviceId": "A String", # The obfuscated ID of the service this privilege is for.
"privilegeName": "A String", # The name of the privilege.
},
],
}</pre>
</div>
</body></html>
|
