List
|
|||||
|
|
||||
Retrieve all organizational units
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage organization units on your domain
- View organization units on your domain
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
customerId Required |
STRING |
Immutable ID of the G Suite account |
type |
ENUMERATION |
Whether to return all sub-organizations or just immediate children |
orgUnitPath |
STRING |
the URL-encoded organizational unit's path or its ID |
= Parameter name
= Format
|
customerId STRING Required Immutable ID of the G Suite account |
|
type ENUMERATION Whether to return all sub-organizations or just immediate children |
|
orgUnitPath STRING the URL-encoded organizational unit's path or its ID |
Output
This building block provides 12 output parameters
| Name | Format | Description |
|---|---|---|
organizationUnits[] |
OBJECT |
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) |
organizationUnits[].orgUnitId |
STRING |
Id of OrgUnit |
organizationUnits[].kind |
STRING |
Kind of resource this is |
organizationUnits[].orgUnitPath |
STRING |
Path of OrgUnit |
organizationUnits[].parentOrgUnitId |
STRING |
Id of parent OrgUnit |
organizationUnits[].etag |
STRING |
ETag of the resource |
organizationUnits[].blockInheritance |
BOOLEAN |
Should block inheritance |
organizationUnits[].name |
STRING |
Name of OrgUnit |
organizationUnits[].parentOrgUnitPath |
STRING |
Path of parent OrgUnit |
organizationUnits[].description |
STRING |
Description of OrgUnit |
kind |
STRING |
Kind of resource this is |
etag |
STRING |
ETag of the resource |
= Parameter name
= Format
|
organizationUnits[] OBJECT 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) |
|
organizationUnits[].orgUnitId STRING Id of OrgUnit |
|
organizationUnits[].kind STRING Kind of resource this is |
|
organizationUnits[].orgUnitPath STRING Path of OrgUnit |
|
organizationUnits[].parentOrgUnitId STRING Id of parent OrgUnit |
|
organizationUnits[].etag STRING ETag of the resource |
|
organizationUnits[].blockInheritance BOOLEAN Should block inheritance |
|
organizationUnits[].name STRING Name of OrgUnit |
|
organizationUnits[].parentOrgUnitPath STRING Path of parent OrgUnit |
|
organizationUnits[].description STRING Description of OrgUnit |
|
kind STRING Kind of resource this is |
|
etag STRING ETag of the resource |