GoogleApi.Admin.Directory_v1.Model.OrgUnit (google_api_admin v0.35.0) View Source

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.


  • blockInheritance (type: boolean(), default: nil) - 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.
  • description (type: String.t, default: nil) - Description of the organizational unit.
  • etag (type: String.t, default: nil) - ETag of the resource.
  • kind (type: String.t, default: admin#directory#orgUnit) - The type of the API resource. For Orgunits resources, the value is admin#directory#orgUnit.
  • name (type: String.t, default: nil) - 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.
  • orgUnitId (type: String.t, default: nil) - The unique ID of the organizational unit.
  • orgUnitPath (type: String.t, default: nil) - 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 (type: String.t, default: nil) - The unique ID of the parent organizational unit. Required, unless parentOrgUnitPath is set.
  • parentOrgUnitPath (type: String.t, default: nil) - 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.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Admin.Directory_v1.Model.OrgUnit{
  blockInheritance: boolean() | nil,
  description: String.t() | nil,
  etag: String.t() | nil,
  kind: String.t() | nil,
  name: String.t() | nil,
  orgUnitId: String.t() | nil,
  orgUnitPath: String.t() | nil,
  parentOrgUnitId: String.t() | nil,
  parentOrgUnitPath: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.