Orgunits: update

Requires authorization

Updates an organizational unit.

Request

HTTP request

PUT https://www.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath*

Parameters

Parameter name Value Description
Path parameters
customerId string The unique ID for the customer's G Suite 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.
orgUnitPath string The full path of the organizational unit or its unique ID.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/admin.directory.orgunit

Request body

In the request body, supply an Orgunits resource with the following properties:

Property name Value Description Notes
Optional Properties
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
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
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

Response

If successful, this method returns an Orgunits resource in the response body.

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.