Class: Google::Apis::AdminDirectoryV1::OrgUnit
- Inherits:
-
Object
- Object
- Google::Apis::AdminDirectoryV1::OrgUnit
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/admin_directory_v1/classes.rb,
lib/google/apis/admin_directory_v1/representations.rb,
lib/google/apis/admin_directory_v1/representations.rb
Overview
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.
Instance Attribute Summary collapse
-
#block_inheritance ⇒ Boolean
(also: #block_inheritance?)
Determines if a sub-organizational unit can inherit the settings of the parent organization.
-
#description ⇒ String
Description of the organizational unit.
-
#etag ⇒ String
ETag of the resource.
-
#kind ⇒ String
The type of the API resource.
-
#name ⇒ String
The organizational unit's path name.
-
#org_unit_id ⇒ String
The unique ID of the organizational unit.
-
#org_unit_path ⇒ String
The full path to the organizational unit.
-
#parent_org_unit_id ⇒ String
The unique ID of the parent organizational unit.
-
#parent_org_unit_path ⇒ String
The organizational unit's parent path.
Instance Method Summary collapse
-
#initialize(**args) ⇒ OrgUnit
constructor
A new instance of OrgUnit.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ OrgUnit
Returns a new instance of OrgUnit.
3416 3417 3418 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3416 def initialize(**args) update!(**args) end |
Instance Attribute Details
#block_inheritance ⇒ Boolean Also known as: block_inheritance?
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. This field is
deprecated. Setting it to true
is no longer supported and can have
unintended consequences. For more information about inheritance and users in
an organization structure, see the administration help center.
Corresponds to the JSON property blockInheritance
3356 3357 3358 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3356 def block_inheritance @block_inheritance end |
#description ⇒ String
Description of the organizational unit.
Corresponds to the JSON property description
3362 3363 3364 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3362 def description @description end |
#etag ⇒ String
ETag of the resource.
Corresponds to the JSON property etag
3367 3368 3369 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3367 def etag @etag end |
#kind ⇒ String
The type of the API resource. For Orgunits resources, the value is admin#
directory#orgUnit
.
Corresponds to the JSON property kind
3373 3374 3375 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3373 def kind @kind end |
#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.
Corresponds to the JSON property name
3380 3381 3382 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3380 def name @name end |
#org_unit_id ⇒ String
The unique ID of the organizational unit.
Corresponds to the JSON property orgUnitId
3385 3386 3387 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3385 def org_unit_id @org_unit_id end |
#org_unit_path ⇒ 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.
Corresponds to the JSON property orgUnitPath
3401 3402 3403 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3401 def org_unit_path @org_unit_path end |
#parent_org_unit_id ⇒ String
The unique ID of the parent organizational unit. Required, unless
parentOrgUnitPath
is set.
Corresponds to the JSON property parentOrgUnitId
3407 3408 3409 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3407 def parent_org_unit_id @parent_org_unit_id end |
#parent_org_unit_path ⇒ 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.
Corresponds to the JSON property parentOrgUnitPath
3414 3415 3416 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3414 def parent_org_unit_path @parent_org_unit_path end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 |
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 3421 def update!(**args) @block_inheritance = args[:block_inheritance] if args.key?(:block_inheritance) @description = args[:description] if args.key?(:description) @etag = args[:etag] if args.key?(:etag) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @org_unit_id = args[:org_unit_id] if args.key?(:org_unit_id) @org_unit_path = args[:org_unit_path] if args.key?(:org_unit_path) @parent_org_unit_id = args[:parent_org_unit_id] if args.key?(:parent_org_unit_id) @parent_org_unit_path = args[:parent_org_unit_path] if args.key?(:parent_org_unit_path) end |