1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. Orgunits

Orgunits

class Orgunits extends Resource (View source)

The "orgunits" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $orgunits = $adminService->orgunits;

Methods

delete(string $customerId, string $orgUnitPath, array $optParams = [])

Removes an organizational unit. (orgunits.delete)

OrgUnit
get(string $customerId, string $orgUnitPath, array $optParams = [])

Retrieves an organizational unit. (orgunits.get)

OrgUnit
insert(string $customerId, OrgUnit $postBody, array $optParams = [])

Adds an organizational unit. (orgunits.insert)

OrgUnits
listOrgunits(string $customerId, array $optParams = [])

Retrieves a list of all organizational units for an account.

OrgUnit
patch(string $customerId, string $orgUnitPath, OrgUnit $postBody, array $optParams = [])

Updates an organizational unit. This method supports patch semantics (orgunits.patch)

OrgUnit
update(string $customerId, string $orgUnitPath, OrgUnit $postBody, array $optParams = [])

Updates an organizational unit. (orgunits.update)

Details

at line 46
delete(string $customerId, string $orgUnitPath, array $optParams = [])

Removes an organizational unit. (orgunits.delete)

Parameters

string $customerId

The unique ID for the customer's Google Workspace 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.
string $orgUnitPath

The full path of the organizational unit (minus the leading /) or its unique ID.
array $optParams

Optional parameters.

Exceptions

Exception

at line 66
OrgUnit get(string $customerId, string $orgUnitPath, array $optParams = [])

Retrieves an organizational unit. (orgunits.get)

Parameters

string $customerId

The unique ID for the customer's Google Workspace 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.
string $orgUnitPath

The full path of the organizational unit (minus the leading /) or its unique ID.
array $optParams

Optional parameters.

Return Value

OrgUnit

Exceptions

Exception

at line 85
OrgUnit insert(string $customerId, OrgUnit $postBody, array $optParams = [])

Adds an organizational unit. (orgunits.insert)

Parameters

string $customerId

The unique ID for the customer's Google Workspace 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.
OrgUnit $postBody
array $optParams

Optional parameters.

Return Value

OrgUnit

Exceptions

Exception

at line 109
OrgUnits listOrgunits(string $customerId, array $optParams = [])

Retrieves a list of all organizational units for an account.

(orgunits.listOrgunits)

Parameters

string $customerId

The unique ID for the customer's Google Workspace 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.
array $optParams

Optional parameters.

Return Value

OrgUnits

Exceptions

Exception

at line 131
OrgUnit patch(string $customerId, string $orgUnitPath, OrgUnit $postBody, array $optParams = [])

Updates an organizational unit. This method supports patch semantics (orgunits.patch)

Parameters

string $customerId

The unique ID for the customer's Google Workspace 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.
string $orgUnitPath

The full path of the organizational unit (minus the leading /) or its unique ID.
OrgUnit $postBody
array $optParams

Optional parameters.

Return Value

OrgUnit

Exceptions

Exception

at line 152
OrgUnit update(string $customerId, string $orgUnitPath, OrgUnit $postBody, array $optParams = [])

Updates an organizational unit. (orgunits.update)

Parameters

string $customerId

The unique ID for the customer's Google Workspace 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.
string $orgUnitPath

The full path of the organizational unit (minus the leading /) or its unique ID.
OrgUnit $postBody
array $optParams

Optional parameters.

Return Value

OrgUnit

Exceptions

Exception