list method

Future<OrgUnits> list(
  1. String customerId, {
  2. String? orgUnitPath,
  3. String? type,
  4. String? $fields,
})

Retrieves a list of all organizational units for an account.

Request parameters:

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](/admin-sdk/directory/v1/reference/users).

orgUnitPath - The full path to the organizational unit or its unique ID. Returns the children of the specified organizational unit.

type - Whether to return all sub-organizations or just immediate children. Possible string values are:

  • "all" : All sub-organizational units.
  • "children" : Immediate children only (default).
  • "allIncludingParent" : All sub-organizational units and the specified organizational unit (root if not specified).

$fields - Selector specifying which fields to include in a partial response.

Completes with a OrgUnits.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<OrgUnits> list(
  core.String customerId, {
  core.String? orgUnitPath,
  core.String? type,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (orgUnitPath != null) 'orgUnitPath': [orgUnitPath],
    if (type != null) 'type': [type],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'admin/directory/v1/customer/' +
      commons.escapeVariable('$customerId') +
      '/orgunits';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return OrgUnits.fromJson(response_ as core.Map<core.String, core.dynamic>);
}