Admin SDK . orgunits

Instance Methods

close()

Close httplib2 connections.

delete(customerId, orgUnitPath, x__xgafv=None)

Remove organizational unit

get(customerId, orgUnitPath, x__xgafv=None)

Retrieve organizational unit

insert(customerId, body=None, x__xgafv=None)

Add organizational unit

list(customerId, orgUnitPath=None, type=None, x__xgafv=None)

Retrieve all organizational units

patch(customerId, orgUnitPath, body=None, x__xgafv=None)

Patch organization unit via Apiary Patch Orchestration

update(customerId, orgUnitPath, body=None, x__xgafv=None)

Update organizational unit

Method Details

close()
Close httplib2 connections.
delete(customerId, orgUnitPath, x__xgafv=None)
Remove organizational unit

Args:
  customerId: string, Immutable ID of the G Suite account (required)
  orgUnitPath: string, Full path of the organizational unit or its ID (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(customerId, orgUnitPath, x__xgafv=None)
Retrieve organizational unit

Args:
  customerId: string, Immutable ID of the G Suite account (required)
  orgUnitPath: string, Full path of the organizational unit or its ID (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "description": "A String", # Description of OrgUnit
      "etag": "A String", # ETag of the resource.
      "name": "A String", # Name of OrgUnit
      "orgUnitId": "A String", # Id of OrgUnit
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "orgUnitPath": "A String", # Path of OrgUnit
      "blockInheritance": True or False, # Should block inheritance
    }
insert(customerId, body=None, x__xgafv=None)
Add organizational unit

Args:
  customerId: string, Immutable ID of the G Suite account (required)
  body: object, The request body.
    The object takes the form of:

{ # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "description": "A String", # Description of OrgUnit
    "etag": "A String", # ETag of the resource.
    "name": "A String", # Name of OrgUnit
    "orgUnitId": "A String", # Id of OrgUnit
    "kind": "admin#directory#orgUnit", # Kind of resource this is.
    "parentOrgUnitPath": "A String", # Path of parent OrgUnit
    "parentOrgUnitId": "A String", # Id of parent OrgUnit
    "orgUnitPath": "A String", # Path of OrgUnit
    "blockInheritance": True or False, # Should block inheritance
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "description": "A String", # Description of OrgUnit
      "etag": "A String", # ETag of the resource.
      "name": "A String", # Name of OrgUnit
      "orgUnitId": "A String", # Id of OrgUnit
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "orgUnitPath": "A String", # Path of OrgUnit
      "blockInheritance": True or False, # Should block inheritance
    }
list(customerId, orgUnitPath=None, type=None, x__xgafv=None)
Retrieve all organizational units

Args:
  customerId: string, Immutable ID of the G Suite account (required)
  orgUnitPath: string, the URL-encoded organizational unit's path or its ID
  type: string, Whether to return all sub-organizations or just immediate children
    Allowed values
      typeUndefined - 
      all - All sub-organizational units.
      children - Immediate children only (default).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON response template for List Organization Units operation in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "organizationUnits": [ # List of user objects.
      { # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
          "description": "A String", # Description of OrgUnit
          "etag": "A String", # ETag of the resource.
          "name": "A String", # Name of OrgUnit
          "orgUnitId": "A String", # Id of OrgUnit
          "kind": "admin#directory#orgUnit", # Kind of resource this is.
          "parentOrgUnitPath": "A String", # Path of parent OrgUnit
          "parentOrgUnitId": "A String", # Id of parent OrgUnit
          "orgUnitPath": "A String", # Path of OrgUnit
          "blockInheritance": True or False, # Should block inheritance
        },
    ],
    "etag": "A String", # ETag of the resource.
    "kind": "admin#directory#orgUnits", # Kind of resource this is.
  }
patch(customerId, orgUnitPath, body=None, x__xgafv=None)
Patch organization unit via Apiary Patch Orchestration

Args:
  customerId: string, Immutable ID of the G Suite account (required)
  orgUnitPath: string, Full path of the organizational unit or its ID (required)
  body: object, The request body.
    The object takes the form of:

{ # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "description": "A String", # Description of OrgUnit
    "etag": "A String", # ETag of the resource.
    "name": "A String", # Name of OrgUnit
    "orgUnitId": "A String", # Id of OrgUnit
    "kind": "admin#directory#orgUnit", # Kind of resource this is.
    "parentOrgUnitPath": "A String", # Path of parent OrgUnit
    "parentOrgUnitId": "A String", # Id of parent OrgUnit
    "orgUnitPath": "A String", # Path of OrgUnit
    "blockInheritance": True or False, # Should block inheritance
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "description": "A String", # Description of OrgUnit
      "etag": "A String", # ETag of the resource.
      "name": "A String", # Name of OrgUnit
      "orgUnitId": "A String", # Id of OrgUnit
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "orgUnitPath": "A String", # Path of OrgUnit
      "blockInheritance": True or False, # Should block inheritance
    }
update(customerId, orgUnitPath, body=None, x__xgafv=None)
Update organizational unit

Args:
  customerId: string, Immutable ID of the G Suite account (required)
  orgUnitPath: string, Full path of the organizational unit or its ID (required)
  body: object, The request body.
    The object takes the form of:

{ # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "description": "A String", # Description of OrgUnit
    "etag": "A String", # ETag of the resource.
    "name": "A String", # Name of OrgUnit
    "orgUnitId": "A String", # Id of OrgUnit
    "kind": "admin#directory#orgUnit", # Kind of resource this is.
    "parentOrgUnitPath": "A String", # Path of parent OrgUnit
    "parentOrgUnitId": "A String", # Id of parent OrgUnit
    "orgUnitPath": "A String", # Path of OrgUnit
    "blockInheritance": True or False, # Should block inheritance
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON template for Org Unit resource in Directory API. STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "description": "A String", # Description of OrgUnit
      "etag": "A String", # ETag of the resource.
      "name": "A String", # Name of OrgUnit
      "orgUnitId": "A String", # Id of OrgUnit
      "kind": "admin#directory#orgUnit", # Kind of resource this is.
      "parentOrgUnitPath": "A String", # Path of parent OrgUnit
      "parentOrgUnitId": "A String", # Id of parent OrgUnit
      "orgUnitPath": "A String", # Path of OrgUnit
      "blockInheritance": True or False, # Should block inheritance
    }