Debian Codegraph @

docs/dyn/admin_directory_v1.orgunits.html

raw
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 SDK API</a> . <a href="admin_directory_v1.orgunits.html">orgunits</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(customerId, orgUnitPath, x__xgafv=None)</a></code></p>
82 <p class="firstline">Removes an organizational unit.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(customerId, orgUnitPath, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves an organizational unit.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(customerId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Adds an organizational unit.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(customerId, orgUnitPath=None, type=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves a list of all organizational units for an account.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(customerId, orgUnitPath, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)</p>
95 <p class="toc_element">
96 <code><a href="#update">update(customerId, orgUnitPath, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an organizational unit.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="delete">delete(customerId, orgUnitPath, x__xgafv=None)</code>
106 <pre>Removes an organizational unit.
107
108 Args:
109 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
110 orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115 </pre>
116 </div>
117
118 <div class="method">
119 <code class="details" id="get">get(customerId, orgUnitPath, x__xgafv=None)</code>
120 <pre>Retrieves an organizational unit.
121
122 Args:
123 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
124 orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130 Returns:
131 An object of the form:
132
133 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
134 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
135 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
136 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
137 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
138 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
139 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
140 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
141 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
142 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
143 }</pre>
144 </div>
145
146 <div class="method">
147 <code class="details" id="insert">insert(customerId, body=None, x__xgafv=None)</code>
148 <pre>Adds an organizational unit.
149
150 Args:
151 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
152 body: object, The request body.
153 The object takes the form of:
154
155 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
156 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
157 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
158 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
159 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
160 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
161 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
162 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
163 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
164 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
165 }
166
167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172 Returns:
173 An object of the form:
174
175 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
176 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
177 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
178 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
179 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
180 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
181 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
182 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
183 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
184 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
185 }</pre>
186 </div>
187
188 <div class="method">
189 <code class="details" id="list">list(customerId, orgUnitPath=None, type=None, x__xgafv=None)</code>
190 <pre>Retrieves a list of all organizational units for an account.
191
192 Args:
193 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
194 orgUnitPath: string, The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.
195 type: string, Whether to return all sub-organizations or just immediate children.
196 Allowed values
197 all - All sub-organizational units.
198 children - Immediate children only (default).
199 allIncludingParent - All sub-organizational units and the specified organizational unit (root if not specified).
200 x__xgafv: string, V1 error format.
201 Allowed values
202 1 - v1 error format
203 2 - v2 error format
204
205 Returns:
206 An object of the form:
207
208 {
209 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
210 &quot;kind&quot;: &quot;admin#directory#orgUnits&quot;, # The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`.
211 &quot;organizationUnits&quot;: [ # A list of organizational unit objects.
212 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
213 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
214 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
215 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
216 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
217 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
218 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
219 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
220 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
221 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
222 },
223 ],
224 }</pre>
225 </div>
226
227 <div class="method">
228 <code class="details" id="patch">patch(customerId, orgUnitPath, body=None, x__xgafv=None)</code>
229 <pre>Updates an organizational unit. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch)
230
231 Args:
232 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
233 orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
234 body: object, The request body.
235 The object takes the form of:
236
237 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
238 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
239 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
240 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
241 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
242 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
243 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
244 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
245 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
246 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
247 }
248
249 x__xgafv: string, V1 error format.
250 Allowed values
251 1 - v1 error format
252 2 - v2 error format
253
254 Returns:
255 An object of the form:
256
257 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
258 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
259 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
260 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
261 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
262 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
263 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
264 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
265 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
266 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
267 }</pre>
268 </div>
269
270 <div class="method">
271 <code class="details" id="update">update(customerId, orgUnitPath, body=None, x__xgafv=None)</code>
272 <pre>Updates an organizational unit.
273
274 Args:
275 customerId: string, The unique ID for the customer&#x27;s Google Workspace account. As an account administrator, you can also use the `my_customer` alias to represent your account&#x27;s `customerId`. The `customerId` is also returned as part of the [Users resource](https://developers.google.com/workspace/admin/directory/v1/reference/users). (required)
276 orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required)
277 body: object, The request body.
278 The object takes the form of:
279
280 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
281 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
282 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
283 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
284 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
285 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
286 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
287 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
288 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
289 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
290 }
291
292 x__xgafv: string, V1 error format.
293 Allowed values
294 1 - v1 error format
295 2 - v2 error format
296
297 Returns:
298 An object of the form:
299
300 { # Managing your account&#x27;s organizational units allows you to configure your users&#x27; access to services and custom settings. For more information about common organizational unit tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-org-units.html). The customer&#x27;s organizational unit hierarchy is limited to 35 levels of depth.
301 &quot;blockInheritance&quot;: True or False, # This field is deprecated and setting its value has no effect.
302 &quot;description&quot;: &quot;A String&quot;, # Description of the organizational unit.
303 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
304 &quot;kind&quot;: &quot;admin#directory#orgUnit&quot;, # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
305 &quot;name&quot;: &quot;A String&quot;, # The organizational unit&#x27;s path name. For example, an organizational unit&#x27;s name within the /corp/support/sales_support parent path is sales_support. Required.
306 &quot;orgUnitId&quot;: &quot;A String&quot;, # The unique ID of the organizational unit.
307 &quot;orgUnitPath&quot;: &quot;A String&quot;, # The full path to the organizational unit. The `orgUnitPath` is a derived property. When listed, it is derived from `parentOrgunitPath` and organizational unit&#x27;s `name`. For example, for an organizational unit named &#x27;apps&#x27; under parent organization &#x27;/engineering&#x27;, the orgUnitPath is &#x27;/engineering/apps&#x27;. In order to edit an `orgUnitPath`, either update the name of the organization or the `parentOrgunitPath`. A user&#x27;s organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user&#x27;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](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users.html#update_user).
308 &quot;parentOrgUnitId&quot;: &quot;A String&quot;, # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.
309 &quot;parentOrgUnitPath&quot;: &quot;A String&quot;, # The organizational unit&#x27;s parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless `parentOrgUnitId` is set.
310 }</pre>
311 </div>
312
313 </body></html>