orgunits

Overview

Name	orgunits
Type	Resource
Id	googleadmin.directory.orgunits

Fields

Name	Datatype	Description
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.
description	string	Description of the organizational unit.
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. We recommend using the default value because setting block_inheritance to true can have unintended consequences. For more information about inheritance and users in an organization structure, see the administration help center.
etag	string	ETag of the resource.
kind	string	The type of the API resource. For Orgunits resources, the value is admin#directory#orgUnit.
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 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. For more information about moving a user to a different organization, see Update a user.
parentOrgUnitId	string	The unique ID of the parent organizational unit. Required, unless parentOrgUnitPath is set.
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.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	customerId, orgunitsId	Retrieves an organizational unit.
list	SELECT	customerId	Retrieves a list of all organizational units for an account.
insert	INSERT	customerId	Adds an organizational unit.
delete	DELETE	customerId, orgunitsId	Removes an organizational unit.
_list	EXEC	customerId	Retrieves a list of all organizational units for an account.
patch	EXEC	customerId, orgunitsId	Updates an organizational unit. This method supports patch semantics
update	EXEC	customerId, orgunitsId	Updates an organizational unit.