Orgunits

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.

For a list of methods for this resource, see the end of this page.

Resource representations

The following JSON template is used for Orgunits resources in the Directory API:

{
  "kind": "admin#directory#orgUnit",
  "etag": etag,
  "name": string,
  "description": string,
  "orgUnitPath": string,
  "orgUnitId": string,
  "parentOrgUnitPath": string,
  "parentOrgUnitId": string,
  "blockInheritance": boolean
}

Property name	Value	Description	Notes
`blockInheritance`	`boolean`	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.	writable
`description`	`string`	Description of the organizational unit.	writable
`etag`	`etag`	ETag of the resource.
`kind`	`string`	The type of the API resource. For Orgunits resources, the value is `admin#directory#orgUnit`.
`name`	`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.	writable
`orgUnitId`	`string`	The unique ID of the organizational unit.
`orgUnitPath`	`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 G Suite 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. For more information about moving a user to a different organization, see Update a user.	writable
`parentOrgUnitId`	`string`	The unique ID of the parent organizational unit. Required, unless `parentOrgUnitPath` is set.	writable
`parentOrgUnitPath`	`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.	writable

Methods

delete: Removes an organizational unit.
get: Retrieves an organizational unit.
insert: Adds an organizational unit.
list: Retrieves a list of all organizational units for an account.
patch: Updates an organizational unit. This method supports patch semantics.
update: Updates an organizational unit.