REST Resource: orgunits

    Resource: OrgUnit

    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 . The customer's organizational unit hierarchy is limited to 35 levels of depth.

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "name" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "etag" 
 : 
 string 
 , 
 "blockInheritance" 
 : 
 boolean 
 , 
 "orgUnitId" 
 : 
 string 
 , 
 "orgUnitPath" 
 : 
 string 
 , 
 "parentOrgUnitId" 
 : 
 string 
 , 
 "parentOrgUnitPath" 
 : 
 string 
 }
    Fields
    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.
    description

    string

    Description of the organizational unit.
    etag

    string

    ETag of the resource.
    blockInheritance
    (deprecated)

    boolean

    This field is deprecated and setting its value has no effect.
    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 orgunits.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

    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.

    update

    		Updates an organizational unit.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: