1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.orgunits.html">orgunits</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(customerId, orgUnitPath)</a></code></p> 79 <p class="firstline">Remove Organization Unit</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(customerId, orgUnitPath)</a></code></p> 82 <p class="firstline">Retrieve Organization Unit</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(customerId, body)</a></code></p> 85 <p class="firstline">Add Organization Unit</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(customerId, type=None, orgUnitPath=None)</a></code></p> 88 <p class="firstline">Retrieve all Organization Units</p> 89 <p class="toc_element"> 90 <code><a href="#patch">patch(customerId, orgUnitPath, body)</a></code></p> 91 <p class="firstline">Update Organization Unit. This method supports patch semantics.</p> 92 <p class="toc_element"> 93 <code><a href="#update">update(customerId, orgUnitPath, body)</a></code></p> 94 <p class="firstline">Update Organization Unit</p> 95 <h3>Method Details</h3> 96 <div class="method"> 97 <code class="details" id="delete">delete(customerId, orgUnitPath)</code> 98 <pre>Remove Organization Unit 99 100 Args: 101 customerId: string, Immutable ID of the G Suite account (required) 102 orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated) 103 </pre> 104 </div> 105 106 <div class="method"> 107 <code class="details" id="get">get(customerId, orgUnitPath)</code> 108 <pre>Retrieve Organization Unit 109 110 Args: 111 customerId: string, Immutable ID of the G Suite account (required) 112 orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated) 113 114 Returns: 115 An object of the form: 116 117 { # JSON template for Org Unit resource in Directory API. 118 "kind": "admin#directory#orgUnit", # Kind of resource this is. 119 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 120 "name": "A String", # Name of OrgUnit 121 "etag": "A String", # ETag of the resource. 122 "orgUnitPath": "A String", # Path of OrgUnit 123 "parentOrgUnitId": "A String", # Id of parent OrgUnit 124 "blockInheritance": True or False, # Should block inheritance 125 "orgUnitId": "A String", # Id of OrgUnit 126 "description": "A String", # Description of OrgUnit 127 }</pre> 128 </div> 129 130 <div class="method"> 131 <code class="details" id="insert">insert(customerId, body)</code> 132 <pre>Add Organization Unit 133 134 Args: 135 customerId: string, Immutable ID of the G Suite account (required) 136 body: object, The request body. (required) 137 The object takes the form of: 138 139 { # JSON template for Org Unit resource in Directory API. 140 "kind": "admin#directory#orgUnit", # Kind of resource this is. 141 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 142 "name": "A String", # Name of OrgUnit 143 "etag": "A String", # ETag of the resource. 144 "orgUnitPath": "A String", # Path of OrgUnit 145 "parentOrgUnitId": "A String", # Id of parent OrgUnit 146 "blockInheritance": True or False, # Should block inheritance 147 "orgUnitId": "A String", # Id of OrgUnit 148 "description": "A String", # Description of OrgUnit 149 } 150 151 152 Returns: 153 An object of the form: 154 155 { # JSON template for Org Unit resource in Directory API. 156 "kind": "admin#directory#orgUnit", # Kind of resource this is. 157 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 158 "name": "A String", # Name of OrgUnit 159 "etag": "A String", # ETag of the resource. 160 "orgUnitPath": "A String", # Path of OrgUnit 161 "parentOrgUnitId": "A String", # Id of parent OrgUnit 162 "blockInheritance": True or False, # Should block inheritance 163 "orgUnitId": "A String", # Id of OrgUnit 164 "description": "A String", # Description of OrgUnit 165 }</pre> 166 </div> 167 168 <div class="method"> 169 <code class="details" id="list">list(customerId, type=None, orgUnitPath=None)</code> 170 <pre>Retrieve all Organization Units 171 172 Args: 173 customerId: string, Immutable ID of the G Suite account (required) 174 type: string, Whether to return all sub-organizations or just immediate children 175 Allowed values 176 all - All sub-organization units. 177 children - Immediate children only (default). 178 orgUnitPath: string, the URL-encoded organization unit's path or its Id 179 180 Returns: 181 An object of the form: 182 183 { # JSON response template for List Organization Units operation in Directory API. 184 "kind": "admin#directory#orgUnits", # Kind of resource this is. 185 "etag": "A String", # ETag of the resource. 186 "organizationUnits": [ # List of user objects. 187 { # JSON template for Org Unit resource in Directory API. 188 "kind": "admin#directory#orgUnit", # Kind of resource this is. 189 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 190 "name": "A String", # Name of OrgUnit 191 "etag": "A String", # ETag of the resource. 192 "orgUnitPath": "A String", # Path of OrgUnit 193 "parentOrgUnitId": "A String", # Id of parent OrgUnit 194 "blockInheritance": True or False, # Should block inheritance 195 "orgUnitId": "A String", # Id of OrgUnit 196 "description": "A String", # Description of OrgUnit 197 }, 198 ], 199 }</pre> 200 </div> 201 202 <div class="method"> 203 <code class="details" id="patch">patch(customerId, orgUnitPath, body)</code> 204 <pre>Update Organization Unit. This method supports patch semantics. 205 206 Args: 207 customerId: string, Immutable ID of the G Suite account (required) 208 orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated) 209 body: object, The request body. (required) 210 The object takes the form of: 211 212 { # JSON template for Org Unit resource in Directory API. 213 "kind": "admin#directory#orgUnit", # Kind of resource this is. 214 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 215 "name": "A String", # Name of OrgUnit 216 "etag": "A String", # ETag of the resource. 217 "orgUnitPath": "A String", # Path of OrgUnit 218 "parentOrgUnitId": "A String", # Id of parent OrgUnit 219 "blockInheritance": True or False, # Should block inheritance 220 "orgUnitId": "A String", # Id of OrgUnit 221 "description": "A String", # Description of OrgUnit 222 } 223 224 225 Returns: 226 An object of the form: 227 228 { # JSON template for Org Unit resource in Directory API. 229 "kind": "admin#directory#orgUnit", # Kind of resource this is. 230 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 231 "name": "A String", # Name of OrgUnit 232 "etag": "A String", # ETag of the resource. 233 "orgUnitPath": "A String", # Path of OrgUnit 234 "parentOrgUnitId": "A String", # Id of parent OrgUnit 235 "blockInheritance": True or False, # Should block inheritance 236 "orgUnitId": "A String", # Id of OrgUnit 237 "description": "A String", # Description of OrgUnit 238 }</pre> 239 </div> 240 241 <div class="method"> 242 <code class="details" id="update">update(customerId, orgUnitPath, body)</code> 243 <pre>Update Organization Unit 244 245 Args: 246 customerId: string, Immutable ID of the G Suite account (required) 247 orgUnitPath: string, Full path of the organization unit or its Id (required) (repeated) 248 body: object, The request body. (required) 249 The object takes the form of: 250 251 { # JSON template for Org Unit resource in Directory API. 252 "kind": "admin#directory#orgUnit", # Kind of resource this is. 253 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 254 "name": "A String", # Name of OrgUnit 255 "etag": "A String", # ETag of the resource. 256 "orgUnitPath": "A String", # Path of OrgUnit 257 "parentOrgUnitId": "A String", # Id of parent OrgUnit 258 "blockInheritance": True or False, # Should block inheritance 259 "orgUnitId": "A String", # Id of OrgUnit 260 "description": "A String", # Description of OrgUnit 261 } 262 263 264 Returns: 265 An object of the form: 266 267 { # JSON template for Org Unit resource in Directory API. 268 "kind": "admin#directory#orgUnit", # Kind of resource this is. 269 "parentOrgUnitPath": "A String", # Path of parent OrgUnit 270 "name": "A String", # Name of OrgUnit 271 "etag": "A String", # ETag of the resource. 272 "orgUnitPath": "A String", # Path of OrgUnit 273 "parentOrgUnitId": "A String", # Id of parent OrgUnit 274 "blockInheritance": True or False, # Should block inheritance 275 "orgUnitId": "A String", # Id of OrgUnit 276 "description": "A String", # Description of OrgUnit 277 }</pre> 278 </div> 279 280 </body></html>
