/
admin_directory_v1.orgunits.html
312 lines (268 loc) 路 28.5 KB
/
admin_directory_v1.orgunits.html
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
<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 SDK API</a> . <a href="admin_directory_v1.orgunits.html">orgunits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(customerId, orgUnitPath, x__xgafv=None)</a></code></p>
<p class="firstline">Removes an organizational unit.</p>
<p class="toc_element">
<code><a href="#get">get(customerId, orgUnitPath, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves an organizational unit.</p>
<p class="toc_element">
<code><a href="#insert">insert(customerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds an organizational unit.</p>
<p class="toc_element">
<code><a href="#list">list(customerId, orgUnitPath=None, type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of all organizational units for an account.</p>
<p class="toc_element">
<code><a href="#patch">patch(customerId, orgUnitPath, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an organizational unit. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch)</p>
<p class="toc_element">
<code><a href="#update">update(customerId, orgUnitPath, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an organizational unit.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(customerId, orgUnitPath, x__xgafv=None)</code>
<pre>Removes an organizational unit.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit or its unique ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(customerId, orgUnitPath, x__xgafv=None)</code>
<pre>Retrieves an organizational unit.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit or its unique ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(customerId, body=None, x__xgafv=None)</code>
<pre>Adds an organizational unit.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
body: object, The request body.
The object takes the form of:
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(customerId, orgUnitPath=None, type=None, x__xgafv=None)</code>
<pre>Retrieves a list of all organizational units for an account.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
orgUnitPath: string, The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.
type: string, Whether to return all sub-organizations or just immediate children.
Allowed values
all - All sub-organizational units.
children - Immediate children only (default).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnits", # The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.
"organizationUnits": [ # List of organizational unit objects.
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(customerId, orgUnitPath, body=None, x__xgafv=None)</code>
<pre>Updates an organizational unit. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch)
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit or its unique ID. (required)
body: object, The request body.
The object takes the form of:
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(customerId, orgUnitPath, body=None, x__xgafv=None)</code>
<pre>Updates an organizational unit.
Args:
customerId: string, The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users resource](/admin-sdk/directory/v1/reference/users). (required)
orgUnitPath: string, The full path of the organizational unit or its unique ID. (required)
body: object, The request body.
The object takes the form of:
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-org-units.html).
"blockInheritance": True or False, # Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).
"description": "A String", # Description of the organizational unit.
"etag": "A String", # ETag of the resource.
"kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
"name": "A String", # The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required.
"orgUnitId": "A String", # The unique ID of the organizational unit.
"orgUnitPath": "A String", # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit's `name`. For example, for an organizational unit named 'apps' under parent organization '/engineering', the orgUnitPath is '/engineering/apps'. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the [administration help center](https://support.google.com/a/answer/4352075). For more information about moving a user to a different organization, see [Update a user](/admin-sdk/directory/v1/guides/manage-users.html#update_user).
"parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
"parentOrgUnitPath": "A String", # The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
}</pre>
</div>
</body></html>