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.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](/admin-sdk/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 108Args: 109 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) 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 122Args: 123 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) 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 130Returns: 131 An object of the form: 132 133 { # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 134 "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). 135 "description": "A String", # Description of the organizational unit. 136 "etag": "A String", # ETag of the resource. 137 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 138 "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. 139 "orgUnitId": "A String", # The unique ID of the organizational unit. 140 "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). 141 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 142 "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. 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 150Args: 151 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) 152 body: object, The request body. 153 The object takes the form of: 154 155{ # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 156 "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). 157 "description": "A String", # Description of the organizational unit. 158 "etag": "A String", # ETag of the resource. 159 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 160 "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. 161 "orgUnitId": "A String", # The unique ID of the organizational unit. 162 "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). 163 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 164 "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. 165} 166 167 x__xgafv: string, V1 error format. 168 Allowed values 169 1 - v1 error format 170 2 - v2 error format 171 172Returns: 173 An object of the form: 174 175 { # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 176 "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). 177 "description": "A String", # Description of the organizational unit. 178 "etag": "A String", # ETag of the resource. 179 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 180 "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. 181 "orgUnitId": "A String", # The unique ID of the organizational unit. 182 "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). 183 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 184 "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. 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 192Args: 193 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) 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 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { 208 "etag": "A String", # ETag of the resource. 209 "kind": "admin#directory#orgUnits", # The type of the API resource. For Org Unit resources, the type is `admin#directory#orgUnits`. 210 "organizationUnits": [ # List of organizational unit objects. 211 { # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 212 "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). 213 "description": "A String", # Description of the organizational unit. 214 "etag": "A String", # ETag of the resource. 215 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 216 "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. 217 "orgUnitId": "A String", # The unique ID of the organizational unit. 218 "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). 219 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 220 "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. 221 }, 222 ], 223}</pre> 224</div> 225 226<div class="method"> 227 <code class="details" id="patch">patch(customerId, orgUnitPath, body=None, x__xgafv=None)</code> 228 <pre>Updates an organizational unit. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch) 229 230Args: 231 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) 232 orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required) 233 body: object, The request body. 234 The object takes the form of: 235 236{ # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 237 "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). 238 "description": "A String", # Description of the organizational unit. 239 "etag": "A String", # ETag of the resource. 240 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 241 "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. 242 "orgUnitId": "A String", # The unique ID of the organizational unit. 243 "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). 244 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 245 "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. 246} 247 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 257 "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). 258 "description": "A String", # Description of the organizational unit. 259 "etag": "A String", # ETag of the resource. 260 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 261 "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. 262 "orgUnitId": "A String", # The unique ID of the organizational unit. 263 "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). 264 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 265 "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. 266}</pre> 267</div> 268 269<div class="method"> 270 <code class="details" id="update">update(customerId, orgUnitPath, body=None, x__xgafv=None)</code> 271 <pre>Updates an organizational unit. 272 273Args: 274 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) 275 orgUnitPath: string, The full path of the organizational unit (minus the leading `/`) or its unique ID. (required) 276 body: object, The request body. 277 The object takes the form of: 278 279{ # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 280 "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). 281 "description": "A String", # Description of the organizational unit. 282 "etag": "A String", # ETag of the resource. 283 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 284 "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. 285 "orgUnitId": "A String", # The unique ID of the organizational unit. 286 "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). 287 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 288 "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. 289} 290 291 x__xgafv: string, V1 error format. 292 Allowed values 293 1 - v1 error format 294 2 - v2 error format 295 296Returns: 297 An object of the form: 298 299 { # 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). The customer's organizational unit hierarchy is limited to 35 levels of depth. 300 "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). 301 "description": "A String", # Description of the organizational unit. 302 "etag": "A String", # ETag of the resource. 303 "kind": "admin#directory#orgUnit", # The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`. 304 "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. 305 "orgUnitId": "A String", # The unique ID of the organizational unit. 306 "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). 307 "parentOrgUnitId": "A String", # The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set. 308 "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. 309}</pre> 310</div> 311 312</body></html>