| OLD | NEW |
|---|
| (Empty) | |
| 1 { |
| 2 "auth": { |
| 3 "oauth2": { |
| 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/admin.directory.device.chromeos
": { |
| 6 "description": "View and manage your Chrome OS devices' meta
data" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/admin.directory.device.chromeos
.readonly": { |
| 9 "description": "View your Chrome OS devices' metadata" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/admin.directory.device.mobile":
{ |
| 12 "description": "View and manage your mobile devices' metadat
a" |
| 13 }, |
| 14 "https://www.googleapis.com/auth/admin.directory.device.mobile.a
ction": { |
| 15 "description": "Manage your mobile devices by performing adm
inistrative tasks" |
| 16 }, |
| 17 "https://www.googleapis.com/auth/admin.directory.device.mobile.r
eadonly": { |
| 18 "description": "View your mobile devices' metadata" |
| 19 }, |
| 20 "https://www.googleapis.com/auth/admin.directory.group": { |
| 21 "description": "View and manage the provisioning of groups o
n your domain" |
| 22 }, |
| 23 "https://www.googleapis.com/auth/admin.directory.group.member":
{ |
| 24 "description": "View and manage group subscriptions on your
domain" |
| 25 }, |
| 26 "https://www.googleapis.com/auth/admin.directory.group.member.re
adonly": { |
| 27 "description": "View group subscriptions on your domain" |
| 28 }, |
| 29 "https://www.googleapis.com/auth/admin.directory.group.readonly"
: { |
| 30 "description": "View groups on your domain" |
| 31 }, |
| 32 "https://www.googleapis.com/auth/admin.directory.notifications":
{ |
| 33 "description": "View and manage notifications received on yo
ur domain" |
| 34 }, |
| 35 "https://www.googleapis.com/auth/admin.directory.orgunit": { |
| 36 "description": "View and manage organization units on your d
omain" |
| 37 }, |
| 38 "https://www.googleapis.com/auth/admin.directory.orgunit.readonl
y": { |
| 39 "description": "View organization units on your domain" |
| 40 }, |
| 41 "https://www.googleapis.com/auth/admin.directory.user": { |
| 42 "description": "View and manage the provisioning of users on
your domain" |
| 43 }, |
| 44 "https://www.googleapis.com/auth/admin.directory.user.alias": { |
| 45 "description": "View and manage user aliases on your domain" |
| 46 }, |
| 47 "https://www.googleapis.com/auth/admin.directory.user.alias.read
only": { |
| 48 "description": "View user aliases on your domain" |
| 49 }, |
| 50 "https://www.googleapis.com/auth/admin.directory.user.readonly":
{ |
| 51 "description": "View users on your domain" |
| 52 }, |
| 53 "https://www.googleapis.com/auth/admin.directory.user.security":
{ |
| 54 "description": "Manage data access permissions for users on
your domain" |
| 55 } |
| 56 } |
| 57 } |
| 58 }, |
| 59 "basePath": "/admin/directory/v1/", |
| 60 "baseUrl": "https://www.googleapis.com/admin/directory/v1/", |
| 61 "batchPath": "batch", |
| 62 "canonicalName": "directory", |
| 63 "description": "The Admin SDK Directory API lets you view and manage enterpr
ise resources such as users and groups, administrative notifications, security f
eatures, and more.", |
| 64 "discoveryVersion": "v1", |
| 65 "documentationLink": "https://developers.google.com/admin-sdk/directory/", |
| 66 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/j_ZwE0C9AiYczX4hTNBHFJNHzq0\"", |
| 67 "icons": { |
| 68 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 69 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 70 }, |
| 71 "id": "admin:directory_v1", |
| 72 "kind": "discovery#restDescription", |
| 73 "name": "admin", |
| 74 "ownerDomain": "google.com", |
| 75 "ownerName": "Google", |
| 76 "packagePath": "admin", |
| 77 "parameters": { |
| 78 "alt": { |
| 79 "default": "json", |
| 80 "description": "Data format for the response.", |
| 81 "enum": [ |
| 82 "json" |
| 83 ], |
| 84 "enumDescriptions": [ |
| 85 "Responses with Content-Type of application/json" |
| 86 ], |
| 87 "location": "query", |
| 88 "type": "string" |
| 89 }, |
| 90 "fields": { |
| 91 "description": "Selector specifying which fields to include in a par
tial response.", |
| 92 "location": "query", |
| 93 "type": "string" |
| 94 }, |
| 95 "key": { |
| 96 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
| 100 "oauth_token": { |
| 101 "description": "OAuth 2.0 token for the current user.", |
| 102 "location": "query", |
| 103 "type": "string" |
| 104 }, |
| 105 "prettyPrint": { |
| 106 "default": "true", |
| 107 "description": "Returns response with indentations and line breaks."
, |
| 108 "location": "query", |
| 109 "type": "boolean" |
| 110 }, |
| 111 "quotaUser": { |
| 112 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", |
| 113 "location": "query", |
| 114 "type": "string" |
| 115 }, |
| 116 "userIp": { |
| 117 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 118 "location": "query", |
| 119 "type": "string" |
| 120 } |
| 121 }, |
| 122 "protocol": "rest", |
| 123 "resources": { |
| 124 "asps": { |
| 125 "methods": { |
| 126 "delete": { |
| 127 "description": "Delete an ASP issued by a user.", |
| 128 "httpMethod": "DELETE", |
| 129 "id": "directory.asps.delete", |
| 130 "parameterOrder": [ |
| 131 "userKey", |
| 132 "codeId" |
| 133 ], |
| 134 "parameters": { |
| 135 "codeId": { |
| 136 "description": "The unique ID of the ASP to be delet
ed.", |
| 137 "format": "int32", |
| 138 "location": "path", |
| 139 "required": true, |
| 140 "type": "integer" |
| 141 }, |
| 142 "userKey": { |
| 143 "description": "Identifies the user in the API reque
st. The value can be the user's primary email address, alias email address, or u
nique user ID.", |
| 144 "location": "path", |
| 145 "required": true, |
| 146 "type": "string" |
| 147 } |
| 148 }, |
| 149 "path": "users/{userKey}/asps/{codeId}", |
| 150 "scopes": [ |
| 151 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 152 ] |
| 153 }, |
| 154 "get": { |
| 155 "description": "Get information about an ASP issued by a use
r.", |
| 156 "httpMethod": "GET", |
| 157 "id": "directory.asps.get", |
| 158 "parameterOrder": [ |
| 159 "userKey", |
| 160 "codeId" |
| 161 ], |
| 162 "parameters": { |
| 163 "codeId": { |
| 164 "description": "The unique ID of the ASP.", |
| 165 "format": "int32", |
| 166 "location": "path", |
| 167 "required": true, |
| 168 "type": "integer" |
| 169 }, |
| 170 "userKey": { |
| 171 "description": "Identifies the user in the API reque
st. The value can be the user's primary email address, alias email address, or u
nique user ID.", |
| 172 "location": "path", |
| 173 "required": true, |
| 174 "type": "string" |
| 175 } |
| 176 }, |
| 177 "path": "users/{userKey}/asps/{codeId}", |
| 178 "response": { |
| 179 "$ref": "Asp" |
| 180 }, |
| 181 "scopes": [ |
| 182 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 183 ] |
| 184 }, |
| 185 "list": { |
| 186 "description": "List the ASPs issued by a user.", |
| 187 "httpMethod": "GET", |
| 188 "id": "directory.asps.list", |
| 189 "parameterOrder": [ |
| 190 "userKey" |
| 191 ], |
| 192 "parameters": { |
| 193 "userKey": { |
| 194 "description": "Identifies the user in the API reque
st. The value can be the user's primary email address, alias email address, or u
nique user ID.", |
| 195 "location": "path", |
| 196 "required": true, |
| 197 "type": "string" |
| 198 } |
| 199 }, |
| 200 "path": "users/{userKey}/asps", |
| 201 "response": { |
| 202 "$ref": "Asps" |
| 203 }, |
| 204 "scopes": [ |
| 205 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 206 ] |
| 207 } |
| 208 } |
| 209 }, |
| 210 "channels": { |
| 211 "methods": { |
| 212 "stop": { |
| 213 "description": "Stop watching resources through this channel
", |
| 214 "httpMethod": "POST", |
| 215 "id": "admin.channels.stop", |
| 216 "path": "/admin/directory_v1/channels/stop", |
| 217 "request": { |
| 218 "$ref": "Channel", |
| 219 "parameterName": "resource" |
| 220 }, |
| 221 "scopes": [ |
| 222 "https://www.googleapis.com/auth/admin.directory.user", |
| 223 "https://www.googleapis.com/auth/admin.directory.user.al
ias", |
| 224 "https://www.googleapis.com/auth/admin.directory.user.al
ias.readonly", |
| 225 "https://www.googleapis.com/auth/admin.directory.user.re
adonly" |
| 226 ] |
| 227 } |
| 228 } |
| 229 }, |
| 230 "chromeosdevices": { |
| 231 "methods": { |
| 232 "get": { |
| 233 "description": "Retrieve Chrome OS Device", |
| 234 "httpMethod": "GET", |
| 235 "id": "directory.chromeosdevices.get", |
| 236 "parameterOrder": [ |
| 237 "customerId", |
| 238 "deviceId" |
| 239 ], |
| 240 "parameters": { |
| 241 "customerId": { |
| 242 "description": "Immutable id of the Google Apps acco
unt", |
| 243 "location": "path", |
| 244 "required": true, |
| 245 "type": "string" |
| 246 }, |
| 247 "deviceId": { |
| 248 "description": "Immutable id of Chrome OS Device", |
| 249 "location": "path", |
| 250 "required": true, |
| 251 "type": "string" |
| 252 }, |
| 253 "projection": { |
| 254 "description": "Restrict information returned to a s
et of selected fields.", |
| 255 "enum": [ |
| 256 "BASIC", |
| 257 "FULL" |
| 258 ], |
| 259 "enumDescriptions": [ |
| 260 "Includes only the basic metadata fields (e.g.,
deviceId, serialNumber, status, and user)", |
| 261 "Includes all metadata fields" |
| 262 ], |
| 263 "location": "query", |
| 264 "type": "string" |
| 265 } |
| 266 }, |
| 267 "path": "customer/{customerId}/devices/chromeos/{deviceId}", |
| 268 "response": { |
| 269 "$ref": "ChromeOsDevice" |
| 270 }, |
| 271 "scopes": [ |
| 272 "https://www.googleapis.com/auth/admin.directory.device.
chromeos", |
| 273 "https://www.googleapis.com/auth/admin.directory.device.
chromeos.readonly" |
| 274 ] |
| 275 }, |
| 276 "list": { |
| 277 "description": "Retrieve all Chrome OS Devices of a customer
(paginated)", |
| 278 "httpMethod": "GET", |
| 279 "id": "directory.chromeosdevices.list", |
| 280 "parameterOrder": [ |
| 281 "customerId" |
| 282 ], |
| 283 "parameters": { |
| 284 "customerId": { |
| 285 "description": "Immutable id of the Google Apps acco
unt", |
| 286 "location": "path", |
| 287 "required": true, |
| 288 "type": "string" |
| 289 }, |
| 290 "maxResults": { |
| 291 "description": "Maximum number of results to return.
Default is 100", |
| 292 "format": "int32", |
| 293 "location": "query", |
| 294 "minimum": "1", |
| 295 "type": "integer" |
| 296 }, |
| 297 "orderBy": { |
| 298 "description": "Column to use for sorting results", |
| 299 "enum": [ |
| 300 "annotatedLocation", |
| 301 "annotatedUser", |
| 302 "lastSync", |
| 303 "notes", |
| 304 "serialNumber", |
| 305 "status", |
| 306 "supportEndDate" |
| 307 ], |
| 308 "enumDescriptions": [ |
| 309 "Chromebook location as annotated by the adminis
trator.", |
| 310 "Chromebook user as annotated by administrator."
, |
| 311 "Chromebook last sync.", |
| 312 "Chromebook notes as annotated by the administra
tor.", |
| 313 "Chromebook Serial Number.", |
| 314 "Chromebook status.", |
| 315 "Chromebook support end date." |
| 316 ], |
| 317 "location": "query", |
| 318 "type": "string" |
| 319 }, |
| 320 "pageToken": { |
| 321 "description": "Token to specify next page in the li
st", |
| 322 "location": "query", |
| 323 "type": "string" |
| 324 }, |
| 325 "projection": { |
| 326 "description": "Restrict information returned to a s
et of selected fields.", |
| 327 "enum": [ |
| 328 "BASIC", |
| 329 "FULL" |
| 330 ], |
| 331 "enumDescriptions": [ |
| 332 "Includes only the basic metadata fields (e.g.,
deviceId, serialNumber, status, and user)", |
| 333 "Includes all metadata fields" |
| 334 ], |
| 335 "location": "query", |
| 336 "type": "string" |
| 337 }, |
| 338 "query": { |
| 339 "description": "Search string in the format given at
http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333", |
| 340 "location": "query", |
| 341 "type": "string" |
| 342 }, |
| 343 "sortOrder": { |
| 344 "description": "Whether to return results in ascendi
ng or descending order. Only of use when orderBy is also used", |
| 345 "enum": [ |
| 346 "ASCENDING", |
| 347 "DESCENDING" |
| 348 ], |
| 349 "enumDescriptions": [ |
| 350 "Ascending order.", |
| 351 "Descending order." |
| 352 ], |
| 353 "location": "query", |
| 354 "type": "string" |
| 355 } |
| 356 }, |
| 357 "path": "customer/{customerId}/devices/chromeos", |
| 358 "response": { |
| 359 "$ref": "ChromeOsDevices" |
| 360 }, |
| 361 "scopes": [ |
| 362 "https://www.googleapis.com/auth/admin.directory.device.
chromeos", |
| 363 "https://www.googleapis.com/auth/admin.directory.device.
chromeos.readonly" |
| 364 ] |
| 365 }, |
| 366 "patch": { |
| 367 "description": "Update Chrome OS Device. This method support
s patch semantics.", |
| 368 "httpMethod": "PATCH", |
| 369 "id": "directory.chromeosdevices.patch", |
| 370 "parameterOrder": [ |
| 371 "customerId", |
| 372 "deviceId" |
| 373 ], |
| 374 "parameters": { |
| 375 "customerId": { |
| 376 "description": "Immutable id of the Google Apps acco
unt", |
| 377 "location": "path", |
| 378 "required": true, |
| 379 "type": "string" |
| 380 }, |
| 381 "deviceId": { |
| 382 "description": "Immutable id of Chrome OS Device", |
| 383 "location": "path", |
| 384 "required": true, |
| 385 "type": "string" |
| 386 }, |
| 387 "projection": { |
| 388 "description": "Restrict information returned to a s
et of selected fields.", |
| 389 "enum": [ |
| 390 "BASIC", |
| 391 "FULL" |
| 392 ], |
| 393 "enumDescriptions": [ |
| 394 "Includes only the basic metadata fields (e.g.,
deviceId, serialNumber, status, and user)", |
| 395 "Includes all metadata fields" |
| 396 ], |
| 397 "location": "query", |
| 398 "type": "string" |
| 399 } |
| 400 }, |
| 401 "path": "customer/{customerId}/devices/chromeos/{deviceId}", |
| 402 "request": { |
| 403 "$ref": "ChromeOsDevice" |
| 404 }, |
| 405 "response": { |
| 406 "$ref": "ChromeOsDevice" |
| 407 }, |
| 408 "scopes": [ |
| 409 "https://www.googleapis.com/auth/admin.directory.device.
chromeos" |
| 410 ] |
| 411 }, |
| 412 "update": { |
| 413 "description": "Update Chrome OS Device", |
| 414 "httpMethod": "PUT", |
| 415 "id": "directory.chromeosdevices.update", |
| 416 "parameterOrder": [ |
| 417 "customerId", |
| 418 "deviceId" |
| 419 ], |
| 420 "parameters": { |
| 421 "customerId": { |
| 422 "description": "Immutable id of the Google Apps acco
unt", |
| 423 "location": "path", |
| 424 "required": true, |
| 425 "type": "string" |
| 426 }, |
| 427 "deviceId": { |
| 428 "description": "Immutable id of Chrome OS Device", |
| 429 "location": "path", |
| 430 "required": true, |
| 431 "type": "string" |
| 432 }, |
| 433 "projection": { |
| 434 "description": "Restrict information returned to a s
et of selected fields.", |
| 435 "enum": [ |
| 436 "BASIC", |
| 437 "FULL" |
| 438 ], |
| 439 "enumDescriptions": [ |
| 440 "Includes only the basic metadata fields (e.g.,
deviceId, serialNumber, status, and user)", |
| 441 "Includes all metadata fields" |
| 442 ], |
| 443 "location": "query", |
| 444 "type": "string" |
| 445 } |
| 446 }, |
| 447 "path": "customer/{customerId}/devices/chromeos/{deviceId}", |
| 448 "request": { |
| 449 "$ref": "ChromeOsDevice" |
| 450 }, |
| 451 "response": { |
| 452 "$ref": "ChromeOsDevice" |
| 453 }, |
| 454 "scopes": [ |
| 455 "https://www.googleapis.com/auth/admin.directory.device.
chromeos" |
| 456 ] |
| 457 } |
| 458 } |
| 459 }, |
| 460 "groups": { |
| 461 "methods": { |
| 462 "delete": { |
| 463 "description": "Delete Group", |
| 464 "httpMethod": "DELETE", |
| 465 "id": "directory.groups.delete", |
| 466 "parameterOrder": [ |
| 467 "groupKey" |
| 468 ], |
| 469 "parameters": { |
| 470 "groupKey": { |
| 471 "description": "Email or immutable Id of the group", |
| 472 "location": "path", |
| 473 "required": true, |
| 474 "type": "string" |
| 475 } |
| 476 }, |
| 477 "path": "groups/{groupKey}", |
| 478 "scopes": [ |
| 479 "https://www.googleapis.com/auth/admin.directory.group" |
| 480 ] |
| 481 }, |
| 482 "get": { |
| 483 "description": "Retrieve Group", |
| 484 "httpMethod": "GET", |
| 485 "id": "directory.groups.get", |
| 486 "parameterOrder": [ |
| 487 "groupKey" |
| 488 ], |
| 489 "parameters": { |
| 490 "groupKey": { |
| 491 "description": "Email or immutable Id of the group", |
| 492 "location": "path", |
| 493 "required": true, |
| 494 "type": "string" |
| 495 } |
| 496 }, |
| 497 "path": "groups/{groupKey}", |
| 498 "response": { |
| 499 "$ref": "Group" |
| 500 }, |
| 501 "scopes": [ |
| 502 "https://www.googleapis.com/auth/admin.directory.group", |
| 503 "https://www.googleapis.com/auth/admin.directory.group.r
eadonly" |
| 504 ] |
| 505 }, |
| 506 "insert": { |
| 507 "description": "Create Group", |
| 508 "httpMethod": "POST", |
| 509 "id": "directory.groups.insert", |
| 510 "path": "groups", |
| 511 "request": { |
| 512 "$ref": "Group" |
| 513 }, |
| 514 "response": { |
| 515 "$ref": "Group" |
| 516 }, |
| 517 "scopes": [ |
| 518 "https://www.googleapis.com/auth/admin.directory.group" |
| 519 ] |
| 520 }, |
| 521 "list": { |
| 522 "description": "Retrieve all groups in a domain (paginated)"
, |
| 523 "httpMethod": "GET", |
| 524 "id": "directory.groups.list", |
| 525 "parameters": { |
| 526 "customer": { |
| 527 "description": "Immutable id of the Google Apps acco
unt. In case of multi-domain, to fetch all groups for a customer, fill this fiel
d instead of domain.", |
| 528 "location": "query", |
| 529 "type": "string" |
| 530 }, |
| 531 "domain": { |
| 532 "description": "Name of the domain. Fill this field
to get groups from only this domain. To return all groups in a multi-domain fill
customer field instead.", |
| 533 "location": "query", |
| 534 "type": "string" |
| 535 }, |
| 536 "maxResults": { |
| 537 "description": "Maximum number of results to return.
Default is 200", |
| 538 "format": "int32", |
| 539 "location": "query", |
| 540 "minimum": "1", |
| 541 "type": "integer" |
| 542 }, |
| 543 "pageToken": { |
| 544 "description": "Token to specify next page in the li
st", |
| 545 "location": "query", |
| 546 "type": "string" |
| 547 }, |
| 548 "userKey": { |
| 549 "description": "Email or immutable Id of the user if
only those groups are to be listed, the given user is a member of. If Id, it sh
ould match with id of user object", |
| 550 "location": "query", |
| 551 "type": "string" |
| 552 } |
| 553 }, |
| 554 "path": "groups", |
| 555 "response": { |
| 556 "$ref": "Groups" |
| 557 }, |
| 558 "scopes": [ |
| 559 "https://www.googleapis.com/auth/admin.directory.group", |
| 560 "https://www.googleapis.com/auth/admin.directory.group.r
eadonly" |
| 561 ] |
| 562 }, |
| 563 "patch": { |
| 564 "description": "Update Group. This method supports patch sem
antics.", |
| 565 "httpMethod": "PATCH", |
| 566 "id": "directory.groups.patch", |
| 567 "parameterOrder": [ |
| 568 "groupKey" |
| 569 ], |
| 570 "parameters": { |
| 571 "groupKey": { |
| 572 "description": "Email or immutable Id of the group.
If Id, it should match with id of group object", |
| 573 "location": "path", |
| 574 "required": true, |
| 575 "type": "string" |
| 576 } |
| 577 }, |
| 578 "path": "groups/{groupKey}", |
| 579 "request": { |
| 580 "$ref": "Group" |
| 581 }, |
| 582 "response": { |
| 583 "$ref": "Group" |
| 584 }, |
| 585 "scopes": [ |
| 586 "https://www.googleapis.com/auth/admin.directory.group" |
| 587 ] |
| 588 }, |
| 589 "update": { |
| 590 "description": "Update Group", |
| 591 "httpMethod": "PUT", |
| 592 "id": "directory.groups.update", |
| 593 "parameterOrder": [ |
| 594 "groupKey" |
| 595 ], |
| 596 "parameters": { |
| 597 "groupKey": { |
| 598 "description": "Email or immutable Id of the group.
If Id, it should match with id of group object", |
| 599 "location": "path", |
| 600 "required": true, |
| 601 "type": "string" |
| 602 } |
| 603 }, |
| 604 "path": "groups/{groupKey}", |
| 605 "request": { |
| 606 "$ref": "Group" |
| 607 }, |
| 608 "response": { |
| 609 "$ref": "Group" |
| 610 }, |
| 611 "scopes": [ |
| 612 "https://www.googleapis.com/auth/admin.directory.group" |
| 613 ] |
| 614 } |
| 615 }, |
| 616 "resources": { |
| 617 "aliases": { |
| 618 "methods": { |
| 619 "delete": { |
| 620 "description": "Remove a alias for the group", |
| 621 "httpMethod": "DELETE", |
| 622 "id": "directory.groups.aliases.delete", |
| 623 "parameterOrder": [ |
| 624 "groupKey", |
| 625 "alias" |
| 626 ], |
| 627 "parameters": { |
| 628 "alias": { |
| 629 "description": "The alias to be removed", |
| 630 "location": "path", |
| 631 "required": true, |
| 632 "type": "string" |
| 633 }, |
| 634 "groupKey": { |
| 635 "description": "Email or immutable Id of the
group", |
| 636 "location": "path", |
| 637 "required": true, |
| 638 "type": "string" |
| 639 } |
| 640 }, |
| 641 "path": "groups/{groupKey}/aliases/{alias}", |
| 642 "scopes": [ |
| 643 "https://www.googleapis.com/auth/admin.directory
.group" |
| 644 ] |
| 645 }, |
| 646 "insert": { |
| 647 "description": "Add a alias for the group", |
| 648 "httpMethod": "POST", |
| 649 "id": "directory.groups.aliases.insert", |
| 650 "parameterOrder": [ |
| 651 "groupKey" |
| 652 ], |
| 653 "parameters": { |
| 654 "groupKey": { |
| 655 "description": "Email or immutable Id of the
group", |
| 656 "location": "path", |
| 657 "required": true, |
| 658 "type": "string" |
| 659 } |
| 660 }, |
| 661 "path": "groups/{groupKey}/aliases", |
| 662 "request": { |
| 663 "$ref": "Alias" |
| 664 }, |
| 665 "response": { |
| 666 "$ref": "Alias" |
| 667 }, |
| 668 "scopes": [ |
| 669 "https://www.googleapis.com/auth/admin.directory
.group" |
| 670 ] |
| 671 }, |
| 672 "list": { |
| 673 "description": "List all aliases for a group", |
| 674 "httpMethod": "GET", |
| 675 "id": "directory.groups.aliases.list", |
| 676 "parameterOrder": [ |
| 677 "groupKey" |
| 678 ], |
| 679 "parameters": { |
| 680 "groupKey": { |
| 681 "description": "Email or immutable Id of the
group", |
| 682 "location": "path", |
| 683 "required": true, |
| 684 "type": "string" |
| 685 } |
| 686 }, |
| 687 "path": "groups/{groupKey}/aliases", |
| 688 "response": { |
| 689 "$ref": "Aliases" |
| 690 }, |
| 691 "scopes": [ |
| 692 "https://www.googleapis.com/auth/admin.directory
.group", |
| 693 "https://www.googleapis.com/auth/admin.directory
.group.readonly" |
| 694 ], |
| 695 "supportsSubscription": true |
| 696 } |
| 697 } |
| 698 } |
| 699 } |
| 700 }, |
| 701 "members": { |
| 702 "methods": { |
| 703 "delete": { |
| 704 "description": "Remove membership.", |
| 705 "httpMethod": "DELETE", |
| 706 "id": "directory.members.delete", |
| 707 "parameterOrder": [ |
| 708 "groupKey", |
| 709 "memberKey" |
| 710 ], |
| 711 "parameters": { |
| 712 "groupKey": { |
| 713 "description": "Email or immutable Id of the group", |
| 714 "location": "path", |
| 715 "required": true, |
| 716 "type": "string" |
| 717 }, |
| 718 "memberKey": { |
| 719 "description": "Email or immutable Id of the member"
, |
| 720 "location": "path", |
| 721 "required": true, |
| 722 "type": "string" |
| 723 } |
| 724 }, |
| 725 "path": "groups/{groupKey}/members/{memberKey}", |
| 726 "scopes": [ |
| 727 "https://www.googleapis.com/auth/admin.directory.group", |
| 728 "https://www.googleapis.com/auth/admin.directory.group.m
ember" |
| 729 ] |
| 730 }, |
| 731 "get": { |
| 732 "description": "Retrieve Group Member", |
| 733 "httpMethod": "GET", |
| 734 "id": "directory.members.get", |
| 735 "parameterOrder": [ |
| 736 "groupKey", |
| 737 "memberKey" |
| 738 ], |
| 739 "parameters": { |
| 740 "groupKey": { |
| 741 "description": "Email or immutable Id of the group", |
| 742 "location": "path", |
| 743 "required": true, |
| 744 "type": "string" |
| 745 }, |
| 746 "memberKey": { |
| 747 "description": "Email or immutable Id of the member"
, |
| 748 "location": "path", |
| 749 "required": true, |
| 750 "type": "string" |
| 751 } |
| 752 }, |
| 753 "path": "groups/{groupKey}/members/{memberKey}", |
| 754 "response": { |
| 755 "$ref": "Member" |
| 756 }, |
| 757 "scopes": [ |
| 758 "https://www.googleapis.com/auth/admin.directory.group", |
| 759 "https://www.googleapis.com/auth/admin.directory.group.m
ember", |
| 760 "https://www.googleapis.com/auth/admin.directory.group.m
ember.readonly", |
| 761 "https://www.googleapis.com/auth/admin.directory.group.r
eadonly" |
| 762 ] |
| 763 }, |
| 764 "insert": { |
| 765 "description": "Add user to the specified group.", |
| 766 "httpMethod": "POST", |
| 767 "id": "directory.members.insert", |
| 768 "parameterOrder": [ |
| 769 "groupKey" |
| 770 ], |
| 771 "parameters": { |
| 772 "groupKey": { |
| 773 "description": "Email or immutable Id of the group", |
| 774 "location": "path", |
| 775 "required": true, |
| 776 "type": "string" |
| 777 } |
| 778 }, |
| 779 "path": "groups/{groupKey}/members", |
| 780 "request": { |
| 781 "$ref": "Member" |
| 782 }, |
| 783 "response": { |
| 784 "$ref": "Member" |
| 785 }, |
| 786 "scopes": [ |
| 787 "https://www.googleapis.com/auth/admin.directory.group", |
| 788 "https://www.googleapis.com/auth/admin.directory.group.m
ember" |
| 789 ] |
| 790 }, |
| 791 "list": { |
| 792 "description": "Retrieve all members in a group (paginated)"
, |
| 793 "httpMethod": "GET", |
| 794 "id": "directory.members.list", |
| 795 "parameterOrder": [ |
| 796 "groupKey" |
| 797 ], |
| 798 "parameters": { |
| 799 "groupKey": { |
| 800 "description": "Email or immutable Id of the group", |
| 801 "location": "path", |
| 802 "required": true, |
| 803 "type": "string" |
| 804 }, |
| 805 "maxResults": { |
| 806 "description": "Maximum number of results to return.
Default is 200", |
| 807 "format": "int32", |
| 808 "location": "query", |
| 809 "minimum": "1", |
| 810 "type": "integer" |
| 811 }, |
| 812 "pageToken": { |
| 813 "description": "Token to specify next page in the li
st", |
| 814 "location": "query", |
| 815 "type": "string" |
| 816 }, |
| 817 "roles": { |
| 818 "description": "Comma separated role values to filte
r list results on.", |
| 819 "location": "query", |
| 820 "type": "string" |
| 821 } |
| 822 }, |
| 823 "path": "groups/{groupKey}/members", |
| 824 "response": { |
| 825 "$ref": "Members" |
| 826 }, |
| 827 "scopes": [ |
| 828 "https://www.googleapis.com/auth/admin.directory.group", |
| 829 "https://www.googleapis.com/auth/admin.directory.group.m
ember", |
| 830 "https://www.googleapis.com/auth/admin.directory.group.m
ember.readonly", |
| 831 "https://www.googleapis.com/auth/admin.directory.group.r
eadonly" |
| 832 ] |
| 833 }, |
| 834 "patch": { |
| 835 "description": "Update membership of a user in the specified
group. This method supports patch semantics.", |
| 836 "httpMethod": "PATCH", |
| 837 "id": "directory.members.patch", |
| 838 "parameterOrder": [ |
| 839 "groupKey", |
| 840 "memberKey" |
| 841 ], |
| 842 "parameters": { |
| 843 "groupKey": { |
| 844 "description": "Email or immutable Id of the group.
If Id, it should match with id of group object", |
| 845 "location": "path", |
| 846 "required": true, |
| 847 "type": "string" |
| 848 }, |
| 849 "memberKey": { |
| 850 "description": "Email or immutable Id of the user. I
f Id, it should match with id of member object", |
| 851 "location": "path", |
| 852 "required": true, |
| 853 "type": "string" |
| 854 } |
| 855 }, |
| 856 "path": "groups/{groupKey}/members/{memberKey}", |
| 857 "request": { |
| 858 "$ref": "Member" |
| 859 }, |
| 860 "response": { |
| 861 "$ref": "Member" |
| 862 }, |
| 863 "scopes": [ |
| 864 "https://www.googleapis.com/auth/admin.directory.group", |
| 865 "https://www.googleapis.com/auth/admin.directory.group.m
ember" |
| 866 ] |
| 867 }, |
| 868 "update": { |
| 869 "description": "Update membership of a user in the specified
group.", |
| 870 "httpMethod": "PUT", |
| 871 "id": "directory.members.update", |
| 872 "parameterOrder": [ |
| 873 "groupKey", |
| 874 "memberKey" |
| 875 ], |
| 876 "parameters": { |
| 877 "groupKey": { |
| 878 "description": "Email or immutable Id of the group.
If Id, it should match with id of group object", |
| 879 "location": "path", |
| 880 "required": true, |
| 881 "type": "string" |
| 882 }, |
| 883 "memberKey": { |
| 884 "description": "Email or immutable Id of the user. I
f Id, it should match with id of member object", |
| 885 "location": "path", |
| 886 "required": true, |
| 887 "type": "string" |
| 888 } |
| 889 }, |
| 890 "path": "groups/{groupKey}/members/{memberKey}", |
| 891 "request": { |
| 892 "$ref": "Member" |
| 893 }, |
| 894 "response": { |
| 895 "$ref": "Member" |
| 896 }, |
| 897 "scopes": [ |
| 898 "https://www.googleapis.com/auth/admin.directory.group", |
| 899 "https://www.googleapis.com/auth/admin.directory.group.m
ember" |
| 900 ] |
| 901 } |
| 902 } |
| 903 }, |
| 904 "mobiledevices": { |
| 905 "methods": { |
| 906 "action": { |
| 907 "description": "Take action on Mobile Device", |
| 908 "httpMethod": "POST", |
| 909 "id": "directory.mobiledevices.action", |
| 910 "parameterOrder": [ |
| 911 "customerId", |
| 912 "resourceId" |
| 913 ], |
| 914 "parameters": { |
| 915 "customerId": { |
| 916 "description": "Immutable id of the Google Apps acco
unt", |
| 917 "location": "path", |
| 918 "required": true, |
| 919 "type": "string" |
| 920 }, |
| 921 "resourceId": { |
| 922 "description": "Immutable id of Mobile Device", |
| 923 "location": "path", |
| 924 "required": true, |
| 925 "type": "string" |
| 926 } |
| 927 }, |
| 928 "path": "customer/{customerId}/devices/mobile/{resourceId}/a
ction", |
| 929 "request": { |
| 930 "$ref": "MobileDeviceAction" |
| 931 }, |
| 932 "scopes": [ |
| 933 "https://www.googleapis.com/auth/admin.directory.device.
mobile", |
| 934 "https://www.googleapis.com/auth/admin.directory.device.
mobile.action" |
| 935 ] |
| 936 }, |
| 937 "delete": { |
| 938 "description": "Delete Mobile Device", |
| 939 "httpMethod": "DELETE", |
| 940 "id": "directory.mobiledevices.delete", |
| 941 "parameterOrder": [ |
| 942 "customerId", |
| 943 "resourceId" |
| 944 ], |
| 945 "parameters": { |
| 946 "customerId": { |
| 947 "description": "Immutable id of the Google Apps acco
unt", |
| 948 "location": "path", |
| 949 "required": true, |
| 950 "type": "string" |
| 951 }, |
| 952 "resourceId": { |
| 953 "description": "Immutable id of Mobile Device", |
| 954 "location": "path", |
| 955 "required": true, |
| 956 "type": "string" |
| 957 } |
| 958 }, |
| 959 "path": "customer/{customerId}/devices/mobile/{resourceId}", |
| 960 "scopes": [ |
| 961 "https://www.googleapis.com/auth/admin.directory.device.
mobile" |
| 962 ] |
| 963 }, |
| 964 "get": { |
| 965 "description": "Retrieve Mobile Device", |
| 966 "httpMethod": "GET", |
| 967 "id": "directory.mobiledevices.get", |
| 968 "parameterOrder": [ |
| 969 "customerId", |
| 970 "resourceId" |
| 971 ], |
| 972 "parameters": { |
| 973 "customerId": { |
| 974 "description": "Immutable id of the Google Apps acco
unt", |
| 975 "location": "path", |
| 976 "required": true, |
| 977 "type": "string" |
| 978 }, |
| 979 "projection": { |
| 980 "description": "Restrict information returned to a s
et of selected fields.", |
| 981 "enum": [ |
| 982 "BASIC", |
| 983 "FULL" |
| 984 ], |
| 985 "enumDescriptions": [ |
| 986 "Includes only the basic metadata fields (e.g.,
deviceId, model, status, type, and status)", |
| 987 "Includes all metadata fields" |
| 988 ], |
| 989 "location": "query", |
| 990 "type": "string" |
| 991 }, |
| 992 "resourceId": { |
| 993 "description": "Immutable id of Mobile Device", |
| 994 "location": "path", |
| 995 "required": true, |
| 996 "type": "string" |
| 997 } |
| 998 }, |
| 999 "path": "customer/{customerId}/devices/mobile/{resourceId}", |
| 1000 "response": { |
| 1001 "$ref": "MobileDevice" |
| 1002 }, |
| 1003 "scopes": [ |
| 1004 "https://www.googleapis.com/auth/admin.directory.device.
mobile", |
| 1005 "https://www.googleapis.com/auth/admin.directory.device.
mobile.action", |
| 1006 "https://www.googleapis.com/auth/admin.directory.device.
mobile.readonly" |
| 1007 ] |
| 1008 }, |
| 1009 "list": { |
| 1010 "description": "Retrieve all Mobile Devices of a customer (p
aginated)", |
| 1011 "httpMethod": "GET", |
| 1012 "id": "directory.mobiledevices.list", |
| 1013 "parameterOrder": [ |
| 1014 "customerId" |
| 1015 ], |
| 1016 "parameters": { |
| 1017 "customerId": { |
| 1018 "description": "Immutable id of the Google Apps acco
unt", |
| 1019 "location": "path", |
| 1020 "required": true, |
| 1021 "type": "string" |
| 1022 }, |
| 1023 "maxResults": { |
| 1024 "description": "Maximum number of results to return.
Default is 100", |
| 1025 "format": "int32", |
| 1026 "location": "query", |
| 1027 "minimum": "1", |
| 1028 "type": "integer" |
| 1029 }, |
| 1030 "orderBy": { |
| 1031 "description": "Column to use for sorting results", |
| 1032 "enum": [ |
| 1033 "deviceId", |
| 1034 "email", |
| 1035 "lastSync", |
| 1036 "model", |
| 1037 "name", |
| 1038 "os", |
| 1039 "status", |
| 1040 "type" |
| 1041 ], |
| 1042 "enumDescriptions": [ |
| 1043 "Mobile Device serial number.", |
| 1044 "Owner user email.", |
| 1045 "Last policy settings sync date time of the devi
ce.", |
| 1046 "Mobile Device model.", |
| 1047 "Owner user name.", |
| 1048 "Mobile operating system.", |
| 1049 "Status of the device.", |
| 1050 "Type of the device." |
| 1051 ], |
| 1052 "location": "query", |
| 1053 "type": "string" |
| 1054 }, |
| 1055 "pageToken": { |
| 1056 "description": "Token to specify next page in the li
st", |
| 1057 "location": "query", |
| 1058 "type": "string" |
| 1059 }, |
| 1060 "projection": { |
| 1061 "description": "Restrict information returned to a s
et of selected fields.", |
| 1062 "enum": [ |
| 1063 "BASIC", |
| 1064 "FULL" |
| 1065 ], |
| 1066 "enumDescriptions": [ |
| 1067 "Includes only the basic metadata fields (e.g.,
deviceId, model, status, type, and status)", |
| 1068 "Includes all metadata fields" |
| 1069 ], |
| 1070 "location": "query", |
| 1071 "type": "string" |
| 1072 }, |
| 1073 "query": { |
| 1074 "description": "Search string in the format given at
http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search", |
| 1075 "location": "query", |
| 1076 "type": "string" |
| 1077 }, |
| 1078 "sortOrder": { |
| 1079 "description": "Whether to return results in ascendi
ng or descending order. Only of use when orderBy is also used", |
| 1080 "enum": [ |
| 1081 "ASCENDING", |
| 1082 "DESCENDING" |
| 1083 ], |
| 1084 "enumDescriptions": [ |
| 1085 "Ascending order.", |
| 1086 "Descending order." |
| 1087 ], |
| 1088 "location": "query", |
| 1089 "type": "string" |
| 1090 } |
| 1091 }, |
| 1092 "path": "customer/{customerId}/devices/mobile", |
| 1093 "response": { |
| 1094 "$ref": "MobileDevices" |
| 1095 }, |
| 1096 "scopes": [ |
| 1097 "https://www.googleapis.com/auth/admin.directory.device.
mobile", |
| 1098 "https://www.googleapis.com/auth/admin.directory.device.
mobile.action", |
| 1099 "https://www.googleapis.com/auth/admin.directory.device.
mobile.readonly" |
| 1100 ] |
| 1101 } |
| 1102 } |
| 1103 }, |
| 1104 "notifications": { |
| 1105 "methods": { |
| 1106 "delete": { |
| 1107 "description": "Deletes a notification", |
| 1108 "httpMethod": "DELETE", |
| 1109 "id": "directory.notifications.delete", |
| 1110 "parameterOrder": [ |
| 1111 "customer", |
| 1112 "notificationId" |
| 1113 ], |
| 1114 "parameters": { |
| 1115 "customer": { |
| 1116 "description": "The unique ID for the customer's Goo
gle account. The customerId is also returned as part of the Users resource.", |
| 1117 "location": "path", |
| 1118 "required": true, |
| 1119 "type": "string" |
| 1120 }, |
| 1121 "notificationId": { |
| 1122 "description": "The unique ID of the notification.", |
| 1123 "location": "path", |
| 1124 "required": true, |
| 1125 "type": "string" |
| 1126 } |
| 1127 }, |
| 1128 "path": "customer/{customer}/notifications/{notificationId}"
, |
| 1129 "scopes": [ |
| 1130 "https://www.googleapis.com/auth/admin.directory.notific
ations" |
| 1131 ] |
| 1132 }, |
| 1133 "get": { |
| 1134 "description": "Retrieves a notification.", |
| 1135 "httpMethod": "GET", |
| 1136 "id": "directory.notifications.get", |
| 1137 "parameterOrder": [ |
| 1138 "customer", |
| 1139 "notificationId" |
| 1140 ], |
| 1141 "parameters": { |
| 1142 "customer": { |
| 1143 "description": "The unique ID for the customer's Goo
gle account. The customerId is also returned as part of the Users resource.", |
| 1144 "location": "path", |
| 1145 "required": true, |
| 1146 "type": "string" |
| 1147 }, |
| 1148 "notificationId": { |
| 1149 "description": "The unique ID of the notification.", |
| 1150 "location": "path", |
| 1151 "required": true, |
| 1152 "type": "string" |
| 1153 } |
| 1154 }, |
| 1155 "path": "customer/{customer}/notifications/{notificationId}"
, |
| 1156 "response": { |
| 1157 "$ref": "Notification" |
| 1158 }, |
| 1159 "scopes": [ |
| 1160 "https://www.googleapis.com/auth/admin.directory.notific
ations" |
| 1161 ] |
| 1162 }, |
| 1163 "list": { |
| 1164 "description": "Retrieves a list of notifications.", |
| 1165 "httpMethod": "GET", |
| 1166 "id": "directory.notifications.list", |
| 1167 "parameterOrder": [ |
| 1168 "customer" |
| 1169 ], |
| 1170 "parameters": { |
| 1171 "customer": { |
| 1172 "description": "The unique ID for the customer's Goo
gle account.", |
| 1173 "location": "path", |
| 1174 "required": true, |
| 1175 "type": "string" |
| 1176 }, |
| 1177 "language": { |
| 1178 "description": "The ISO 639-1 code of the language n
otifications are returned in. The default is English (en).", |
| 1179 "location": "query", |
| 1180 "type": "string" |
| 1181 }, |
| 1182 "maxResults": { |
| 1183 "description": "Maximum number of notifications to r
eturn per page. The default is 100.", |
| 1184 "format": "uint32", |
| 1185 "location": "query", |
| 1186 "type": "integer" |
| 1187 }, |
| 1188 "pageToken": { |
| 1189 "description": "The token to specify the page of res
ults to retrieve.", |
| 1190 "location": "query", |
| 1191 "type": "string" |
| 1192 } |
| 1193 }, |
| 1194 "path": "customer/{customer}/notifications", |
| 1195 "response": { |
| 1196 "$ref": "Notifications" |
| 1197 }, |
| 1198 "scopes": [ |
| 1199 "https://www.googleapis.com/auth/admin.directory.notific
ations" |
| 1200 ] |
| 1201 }, |
| 1202 "patch": { |
| 1203 "description": "Updates a notification. This method supports
patch semantics.", |
| 1204 "httpMethod": "PATCH", |
| 1205 "id": "directory.notifications.patch", |
| 1206 "parameterOrder": [ |
| 1207 "customer", |
| 1208 "notificationId" |
| 1209 ], |
| 1210 "parameters": { |
| 1211 "customer": { |
| 1212 "description": "The unique ID for the customer's Goo
gle account.", |
| 1213 "location": "path", |
| 1214 "required": true, |
| 1215 "type": "string" |
| 1216 }, |
| 1217 "notificationId": { |
| 1218 "description": "The unique ID of the notification.", |
| 1219 "location": "path", |
| 1220 "required": true, |
| 1221 "type": "string" |
| 1222 } |
| 1223 }, |
| 1224 "path": "customer/{customer}/notifications/{notificationId}"
, |
| 1225 "request": { |
| 1226 "$ref": "Notification" |
| 1227 }, |
| 1228 "response": { |
| 1229 "$ref": "Notification" |
| 1230 }, |
| 1231 "scopes": [ |
| 1232 "https://www.googleapis.com/auth/admin.directory.notific
ations" |
| 1233 ] |
| 1234 }, |
| 1235 "update": { |
| 1236 "description": "Updates a notification.", |
| 1237 "httpMethod": "PUT", |
| 1238 "id": "directory.notifications.update", |
| 1239 "parameterOrder": [ |
| 1240 "customer", |
| 1241 "notificationId" |
| 1242 ], |
| 1243 "parameters": { |
| 1244 "customer": { |
| 1245 "description": "The unique ID for the customer's Goo
gle account.", |
| 1246 "location": "path", |
| 1247 "required": true, |
| 1248 "type": "string" |
| 1249 }, |
| 1250 "notificationId": { |
| 1251 "description": "The unique ID of the notification.", |
| 1252 "location": "path", |
| 1253 "required": true, |
| 1254 "type": "string" |
| 1255 } |
| 1256 }, |
| 1257 "path": "customer/{customer}/notifications/{notificationId}"
, |
| 1258 "request": { |
| 1259 "$ref": "Notification" |
| 1260 }, |
| 1261 "response": { |
| 1262 "$ref": "Notification" |
| 1263 }, |
| 1264 "scopes": [ |
| 1265 "https://www.googleapis.com/auth/admin.directory.notific
ations" |
| 1266 ] |
| 1267 } |
| 1268 } |
| 1269 }, |
| 1270 "orgunits": { |
| 1271 "methods": { |
| 1272 "delete": { |
| 1273 "description": "Remove Organization Unit", |
| 1274 "httpMethod": "DELETE", |
| 1275 "id": "directory.orgunits.delete", |
| 1276 "parameterOrder": [ |
| 1277 "customerId", |
| 1278 "orgUnitPath" |
| 1279 ], |
| 1280 "parameters": { |
| 1281 "customerId": { |
| 1282 "description": "Immutable id of the Google Apps acco
unt", |
| 1283 "location": "path", |
| 1284 "required": true, |
| 1285 "type": "string" |
| 1286 }, |
| 1287 "orgUnitPath": { |
| 1288 "description": "Full path of the organization unit", |
| 1289 "location": "path", |
| 1290 "repeated": true, |
| 1291 "required": true, |
| 1292 "type": "string" |
| 1293 } |
| 1294 }, |
| 1295 "path": "customer/{customerId}/orgunits{/orgUnitPath*}", |
| 1296 "scopes": [ |
| 1297 "https://www.googleapis.com/auth/admin.directory.orgunit
" |
| 1298 ] |
| 1299 }, |
| 1300 "get": { |
| 1301 "description": "Retrieve Organization Unit", |
| 1302 "httpMethod": "GET", |
| 1303 "id": "directory.orgunits.get", |
| 1304 "parameterOrder": [ |
| 1305 "customerId", |
| 1306 "orgUnitPath" |
| 1307 ], |
| 1308 "parameters": { |
| 1309 "customerId": { |
| 1310 "description": "Immutable id of the Google Apps acco
unt", |
| 1311 "location": "path", |
| 1312 "required": true, |
| 1313 "type": "string" |
| 1314 }, |
| 1315 "orgUnitPath": { |
| 1316 "description": "Full path of the organization unit", |
| 1317 "location": "path", |
| 1318 "repeated": true, |
| 1319 "required": true, |
| 1320 "type": "string" |
| 1321 } |
| 1322 }, |
| 1323 "path": "customer/{customerId}/orgunits{/orgUnitPath*}", |
| 1324 "response": { |
| 1325 "$ref": "OrgUnit" |
| 1326 }, |
| 1327 "scopes": [ |
| 1328 "https://www.googleapis.com/auth/admin.directory.orgunit
", |
| 1329 "https://www.googleapis.com/auth/admin.directory.orgunit
.readonly" |
| 1330 ] |
| 1331 }, |
| 1332 "insert": { |
| 1333 "description": "Add Organization Unit", |
| 1334 "httpMethod": "POST", |
| 1335 "id": "directory.orgunits.insert", |
| 1336 "parameterOrder": [ |
| 1337 "customerId" |
| 1338 ], |
| 1339 "parameters": { |
| 1340 "customerId": { |
| 1341 "description": "Immutable id of the Google Apps acco
unt", |
| 1342 "location": "path", |
| 1343 "required": true, |
| 1344 "type": "string" |
| 1345 } |
| 1346 }, |
| 1347 "path": "customer/{customerId}/orgunits", |
| 1348 "request": { |
| 1349 "$ref": "OrgUnit" |
| 1350 }, |
| 1351 "response": { |
| 1352 "$ref": "OrgUnit" |
| 1353 }, |
| 1354 "scopes": [ |
| 1355 "https://www.googleapis.com/auth/admin.directory.orgunit
" |
| 1356 ] |
| 1357 }, |
| 1358 "list": { |
| 1359 "description": "Retrieve all Organization Units", |
| 1360 "httpMethod": "GET", |
| 1361 "id": "directory.orgunits.list", |
| 1362 "parameterOrder": [ |
| 1363 "customerId" |
| 1364 ], |
| 1365 "parameters": { |
| 1366 "customerId": { |
| 1367 "description": "Immutable id of the Google Apps acco
unt", |
| 1368 "location": "path", |
| 1369 "required": true, |
| 1370 "type": "string" |
| 1371 }, |
| 1372 "orgUnitPath": { |
| 1373 "default": "", |
| 1374 "description": "the URL-encoded organization unit", |
| 1375 "location": "query", |
| 1376 "type": "string" |
| 1377 }, |
| 1378 "type": { |
| 1379 "description": "Whether to return all sub-organizati
ons or just immediate children", |
| 1380 "enum": [ |
| 1381 "all", |
| 1382 "children" |
| 1383 ], |
| 1384 "enumDescriptions": [ |
| 1385 "All sub-organization units.", |
| 1386 "Immediate children only (default)." |
| 1387 ], |
| 1388 "location": "query", |
| 1389 "type": "string" |
| 1390 } |
| 1391 }, |
| 1392 "path": "customer/{customerId}/orgunits", |
| 1393 "response": { |
| 1394 "$ref": "OrgUnits" |
| 1395 }, |
| 1396 "scopes": [ |
| 1397 "https://www.googleapis.com/auth/admin.directory.orgunit
", |
| 1398 "https://www.googleapis.com/auth/admin.directory.orgunit
.readonly" |
| 1399 ] |
| 1400 }, |
| 1401 "patch": { |
| 1402 "description": "Update Organization Unit. This method suppor
ts patch semantics.", |
| 1403 "httpMethod": "PATCH", |
| 1404 "id": "directory.orgunits.patch", |
| 1405 "parameterOrder": [ |
| 1406 "customerId", |
| 1407 "orgUnitPath" |
| 1408 ], |
| 1409 "parameters": { |
| 1410 "customerId": { |
| 1411 "description": "Immutable id of the Google Apps acco
unt", |
| 1412 "location": "path", |
| 1413 "required": true, |
| 1414 "type": "string" |
| 1415 }, |
| 1416 "orgUnitPath": { |
| 1417 "description": "Full path of the organization unit", |
| 1418 "location": "path", |
| 1419 "repeated": true, |
| 1420 "required": true, |
| 1421 "type": "string" |
| 1422 } |
| 1423 }, |
| 1424 "path": "customer/{customerId}/orgunits{/orgUnitPath*}", |
| 1425 "request": { |
| 1426 "$ref": "OrgUnit" |
| 1427 }, |
| 1428 "response": { |
| 1429 "$ref": "OrgUnit" |
| 1430 }, |
| 1431 "scopes": [ |
| 1432 "https://www.googleapis.com/auth/admin.directory.orgunit
" |
| 1433 ] |
| 1434 }, |
| 1435 "update": { |
| 1436 "description": "Update Organization Unit", |
| 1437 "httpMethod": "PUT", |
| 1438 "id": "directory.orgunits.update", |
| 1439 "parameterOrder": [ |
| 1440 "customerId", |
| 1441 "orgUnitPath" |
| 1442 ], |
| 1443 "parameters": { |
| 1444 "customerId": { |
| 1445 "description": "Immutable id of the Google Apps acco
unt", |
| 1446 "location": "path", |
| 1447 "required": true, |
| 1448 "type": "string" |
| 1449 }, |
| 1450 "orgUnitPath": { |
| 1451 "description": "Full path of the organization unit", |
| 1452 "location": "path", |
| 1453 "repeated": true, |
| 1454 "required": true, |
| 1455 "type": "string" |
| 1456 } |
| 1457 }, |
| 1458 "path": "customer/{customerId}/orgunits{/orgUnitPath*}", |
| 1459 "request": { |
| 1460 "$ref": "OrgUnit" |
| 1461 }, |
| 1462 "response": { |
| 1463 "$ref": "OrgUnit" |
| 1464 }, |
| 1465 "scopes": [ |
| 1466 "https://www.googleapis.com/auth/admin.directory.orgunit
" |
| 1467 ] |
| 1468 } |
| 1469 } |
| 1470 }, |
| 1471 "tokens": { |
| 1472 "methods": { |
| 1473 "delete": { |
| 1474 "description": "Delete all access tokens issued by a user fo
r an application.", |
| 1475 "httpMethod": "DELETE", |
| 1476 "id": "directory.tokens.delete", |
| 1477 "parameterOrder": [ |
| 1478 "userKey", |
| 1479 "clientId" |
| 1480 ], |
| 1481 "parameters": { |
| 1482 "clientId": { |
| 1483 "description": "The Client ID of the application the
token is issued to.", |
| 1484 "location": "path", |
| 1485 "required": true, |
| 1486 "type": "string" |
| 1487 }, |
| 1488 "userKey": { |
| 1489 "description": "Identifies the user in the API reque
st. The value can be the user's primary email address, alias email address, or u
nique user ID.", |
| 1490 "location": "path", |
| 1491 "required": true, |
| 1492 "type": "string" |
| 1493 } |
| 1494 }, |
| 1495 "path": "users/{userKey}/tokens/{clientId}", |
| 1496 "scopes": [ |
| 1497 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 1498 ] |
| 1499 }, |
| 1500 "get": { |
| 1501 "description": "Get information about an access token issued
by a user.", |
| 1502 "httpMethod": "GET", |
| 1503 "id": "directory.tokens.get", |
| 1504 "parameterOrder": [ |
| 1505 "userKey", |
| 1506 "clientId" |
| 1507 ], |
| 1508 "parameters": { |
| 1509 "clientId": { |
| 1510 "description": "The Client ID of the application the
token is issued to.", |
| 1511 "location": "path", |
| 1512 "required": true, |
| 1513 "type": "string" |
| 1514 }, |
| 1515 "userKey": { |
| 1516 "description": "Identifies the user in the API reque
st. The value can be the user's primary email address, alias email address, or u
nique user ID.", |
| 1517 "location": "path", |
| 1518 "required": true, |
| 1519 "type": "string" |
| 1520 } |
| 1521 }, |
| 1522 "path": "users/{userKey}/tokens/{clientId}", |
| 1523 "response": { |
| 1524 "$ref": "Token" |
| 1525 }, |
| 1526 "scopes": [ |
| 1527 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 1528 ] |
| 1529 }, |
| 1530 "list": { |
| 1531 "description": "Returns the set of tokens specified user has
issued to 3rd party applications.", |
| 1532 "httpMethod": "GET", |
| 1533 "id": "directory.tokens.list", |
| 1534 "parameterOrder": [ |
| 1535 "userKey" |
| 1536 ], |
| 1537 "parameters": { |
| 1538 "userKey": { |
| 1539 "description": "Identifies the user in the API reque
st. The value can be the user's primary email address, alias email address, or u
nique user ID.", |
| 1540 "location": "path", |
| 1541 "required": true, |
| 1542 "type": "string" |
| 1543 } |
| 1544 }, |
| 1545 "path": "users/{userKey}/tokens", |
| 1546 "response": { |
| 1547 "$ref": "Tokens" |
| 1548 }, |
| 1549 "scopes": [ |
| 1550 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 1551 ] |
| 1552 } |
| 1553 } |
| 1554 }, |
| 1555 "users": { |
| 1556 "methods": { |
| 1557 "delete": { |
| 1558 "description": "Delete user", |
| 1559 "httpMethod": "DELETE", |
| 1560 "id": "directory.users.delete", |
| 1561 "parameterOrder": [ |
| 1562 "userKey" |
| 1563 ], |
| 1564 "parameters": { |
| 1565 "userKey": { |
| 1566 "description": "Email or immutable Id of the user", |
| 1567 "location": "path", |
| 1568 "required": true, |
| 1569 "type": "string" |
| 1570 } |
| 1571 }, |
| 1572 "path": "users/{userKey}", |
| 1573 "scopes": [ |
| 1574 "https://www.googleapis.com/auth/admin.directory.user" |
| 1575 ] |
| 1576 }, |
| 1577 "get": { |
| 1578 "description": "retrieve user", |
| 1579 "httpMethod": "GET", |
| 1580 "id": "directory.users.get", |
| 1581 "parameterOrder": [ |
| 1582 "userKey" |
| 1583 ], |
| 1584 "parameters": { |
| 1585 "userKey": { |
| 1586 "description": "Email or immutable Id of the user", |
| 1587 "location": "path", |
| 1588 "required": true, |
| 1589 "type": "string" |
| 1590 } |
| 1591 }, |
| 1592 "path": "users/{userKey}", |
| 1593 "response": { |
| 1594 "$ref": "User" |
| 1595 }, |
| 1596 "scopes": [ |
| 1597 "https://www.googleapis.com/auth/admin.directory.user", |
| 1598 "https://www.googleapis.com/auth/admin.directory.user.re
adonly" |
| 1599 ] |
| 1600 }, |
| 1601 "insert": { |
| 1602 "description": "create user.", |
| 1603 "httpMethod": "POST", |
| 1604 "id": "directory.users.insert", |
| 1605 "path": "users", |
| 1606 "request": { |
| 1607 "$ref": "User" |
| 1608 }, |
| 1609 "response": { |
| 1610 "$ref": "User" |
| 1611 }, |
| 1612 "scopes": [ |
| 1613 "https://www.googleapis.com/auth/admin.directory.user" |
| 1614 ] |
| 1615 }, |
| 1616 "list": { |
| 1617 "description": "Retrieve either deleted users or all users i
n a domain (paginated)", |
| 1618 "httpMethod": "GET", |
| 1619 "id": "directory.users.list", |
| 1620 "parameters": { |
| 1621 "customer": { |
| 1622 "description": "Immutable id of the Google Apps acco
unt. In case of multi-domain, to fetch all users for a customer, fill this field
instead of domain.", |
| 1623 "location": "query", |
| 1624 "type": "string" |
| 1625 }, |
| 1626 "domain": { |
| 1627 "description": "Name of the domain. Fill this field
to get users from only this domain. To return all users in a multi-domain fill c
ustomer field instead.", |
| 1628 "location": "query", |
| 1629 "type": "string" |
| 1630 }, |
| 1631 "event": { |
| 1632 "description": "Event on which subscription is inten
ded (if subscribing)", |
| 1633 "enum": [ |
| 1634 "add", |
| 1635 "delete", |
| 1636 "makeAdmin", |
| 1637 "undelete", |
| 1638 "update" |
| 1639 ], |
| 1640 "enumDescriptions": [ |
| 1641 "User Created Event", |
| 1642 "User Deleted Event", |
| 1643 "User Admin Status Change Event", |
| 1644 "User Undeleted Event", |
| 1645 "User Updated Event" |
| 1646 ], |
| 1647 "location": "query", |
| 1648 "type": "string" |
| 1649 }, |
| 1650 "maxResults": { |
| 1651 "description": "Maximum number of results to return.
Default is 100. Max allowed is 500", |
| 1652 "format": "int32", |
| 1653 "location": "query", |
| 1654 "maximum": "500", |
| 1655 "minimum": "1", |
| 1656 "type": "integer" |
| 1657 }, |
| 1658 "orderBy": { |
| 1659 "description": "Column to use for sorting results", |
| 1660 "enum": [ |
| 1661 "email", |
| 1662 "familyName", |
| 1663 "givenName" |
| 1664 ], |
| 1665 "enumDescriptions": [ |
| 1666 "Primary email of the user.", |
| 1667 "User's family name.", |
| 1668 "User's given name." |
| 1669 ], |
| 1670 "location": "query", |
| 1671 "type": "string" |
| 1672 }, |
| 1673 "pageToken": { |
| 1674 "description": "Token to specify next page in the li
st", |
| 1675 "location": "query", |
| 1676 "type": "string" |
| 1677 }, |
| 1678 "query": { |
| 1679 "description": "Query string search. Should be of th
e form \"\" where field can be any of supported fields, operators can be one of
'=' for exact match or ':' for prefix match. For prefix match, the value should
always be followed by a *.", |
| 1680 "location": "query", |
| 1681 "type": "string" |
| 1682 }, |
| 1683 "showDeleted": { |
| 1684 "description": "If set to true retrieves the list of
deleted users. Default is false", |
| 1685 "location": "query", |
| 1686 "type": "string" |
| 1687 }, |
| 1688 "sortOrder": { |
| 1689 "description": "Whether to return results in ascendi
ng or descending order.", |
| 1690 "enum": [ |
| 1691 "ASCENDING", |
| 1692 "DESCENDING" |
| 1693 ], |
| 1694 "enumDescriptions": [ |
| 1695 "Ascending order.", |
| 1696 "Descending order." |
| 1697 ], |
| 1698 "location": "query", |
| 1699 "type": "string" |
| 1700 } |
| 1701 }, |
| 1702 "path": "users", |
| 1703 "response": { |
| 1704 "$ref": "Users" |
| 1705 }, |
| 1706 "scopes": [ |
| 1707 "https://www.googleapis.com/auth/admin.directory.user", |
| 1708 "https://www.googleapis.com/auth/admin.directory.user.re
adonly" |
| 1709 ], |
| 1710 "supportsSubscription": true |
| 1711 }, |
| 1712 "makeAdmin": { |
| 1713 "description": "change admin status of a user", |
| 1714 "httpMethod": "POST", |
| 1715 "id": "directory.users.makeAdmin", |
| 1716 "parameterOrder": [ |
| 1717 "userKey" |
| 1718 ], |
| 1719 "parameters": { |
| 1720 "userKey": { |
| 1721 "description": "Email or immutable Id of the user as
admin", |
| 1722 "location": "path", |
| 1723 "required": true, |
| 1724 "type": "string" |
| 1725 } |
| 1726 }, |
| 1727 "path": "users/{userKey}/makeAdmin", |
| 1728 "request": { |
| 1729 "$ref": "UserMakeAdmin" |
| 1730 }, |
| 1731 "scopes": [ |
| 1732 "https://www.googleapis.com/auth/admin.directory.user" |
| 1733 ] |
| 1734 }, |
| 1735 "patch": { |
| 1736 "description": "update user. This method supports patch sema
ntics.", |
| 1737 "httpMethod": "PATCH", |
| 1738 "id": "directory.users.patch", |
| 1739 "parameterOrder": [ |
| 1740 "userKey" |
| 1741 ], |
| 1742 "parameters": { |
| 1743 "userKey": { |
| 1744 "description": "Email or immutable Id of the user. I
f Id, it should match with id of user object", |
| 1745 "location": "path", |
| 1746 "required": true, |
| 1747 "type": "string" |
| 1748 } |
| 1749 }, |
| 1750 "path": "users/{userKey}", |
| 1751 "request": { |
| 1752 "$ref": "User" |
| 1753 }, |
| 1754 "response": { |
| 1755 "$ref": "User" |
| 1756 }, |
| 1757 "scopes": [ |
| 1758 "https://www.googleapis.com/auth/admin.directory.user" |
| 1759 ] |
| 1760 }, |
| 1761 "undelete": { |
| 1762 "description": "Undelete a deleted user", |
| 1763 "httpMethod": "POST", |
| 1764 "id": "directory.users.undelete", |
| 1765 "parameterOrder": [ |
| 1766 "userKey" |
| 1767 ], |
| 1768 "parameters": { |
| 1769 "userKey": { |
| 1770 "description": "The immutable id of the user", |
| 1771 "location": "path", |
| 1772 "required": true, |
| 1773 "type": "string" |
| 1774 } |
| 1775 }, |
| 1776 "path": "users/{userKey}/undelete", |
| 1777 "request": { |
| 1778 "$ref": "UserUndelete" |
| 1779 }, |
| 1780 "scopes": [ |
| 1781 "https://www.googleapis.com/auth/admin.directory.user" |
| 1782 ] |
| 1783 }, |
| 1784 "update": { |
| 1785 "description": "update user", |
| 1786 "httpMethod": "PUT", |
| 1787 "id": "directory.users.update", |
| 1788 "parameterOrder": [ |
| 1789 "userKey" |
| 1790 ], |
| 1791 "parameters": { |
| 1792 "userKey": { |
| 1793 "description": "Email or immutable Id of the user. I
f Id, it should match with id of user object", |
| 1794 "location": "path", |
| 1795 "required": true, |
| 1796 "type": "string" |
| 1797 } |
| 1798 }, |
| 1799 "path": "users/{userKey}", |
| 1800 "request": { |
| 1801 "$ref": "User" |
| 1802 }, |
| 1803 "response": { |
| 1804 "$ref": "User" |
| 1805 }, |
| 1806 "scopes": [ |
| 1807 "https://www.googleapis.com/auth/admin.directory.user" |
| 1808 ] |
| 1809 }, |
| 1810 "watch": { |
| 1811 "description": "Watch for changes in users list", |
| 1812 "httpMethod": "POST", |
| 1813 "id": "directory.users.watch", |
| 1814 "parameters": { |
| 1815 "customer": { |
| 1816 "description": "Immutable id of the Google Apps acco
unt. In case of multi-domain, to fetch all users for a customer, fill this field
instead of domain.", |
| 1817 "location": "query", |
| 1818 "type": "string" |
| 1819 }, |
| 1820 "domain": { |
| 1821 "description": "Name of the domain. Fill this field
to get users from only this domain. To return all users in a multi-domain fill c
ustomer field instead.", |
| 1822 "location": "query", |
| 1823 "type": "string" |
| 1824 }, |
| 1825 "event": { |
| 1826 "description": "Event on which subscription is inten
ded (if subscribing)", |
| 1827 "enum": [ |
| 1828 "add", |
| 1829 "delete", |
| 1830 "makeAdmin", |
| 1831 "undelete", |
| 1832 "update" |
| 1833 ], |
| 1834 "enumDescriptions": [ |
| 1835 "User Created Event", |
| 1836 "User Deleted Event", |
| 1837 "User Admin Status Change Event", |
| 1838 "User Undeleted Event", |
| 1839 "User Updated Event" |
| 1840 ], |
| 1841 "location": "query", |
| 1842 "type": "string" |
| 1843 }, |
| 1844 "maxResults": { |
| 1845 "description": "Maximum number of results to return.
Default is 100. Max allowed is 500", |
| 1846 "format": "int32", |
| 1847 "location": "query", |
| 1848 "maximum": "500", |
| 1849 "minimum": "1", |
| 1850 "type": "integer" |
| 1851 }, |
| 1852 "orderBy": { |
| 1853 "description": "Column to use for sorting results", |
| 1854 "enum": [ |
| 1855 "email", |
| 1856 "familyName", |
| 1857 "givenName" |
| 1858 ], |
| 1859 "enumDescriptions": [ |
| 1860 "Primary email of the user.", |
| 1861 "User's family name.", |
| 1862 "User's given name." |
| 1863 ], |
| 1864 "location": "query", |
| 1865 "type": "string" |
| 1866 }, |
| 1867 "pageToken": { |
| 1868 "description": "Token to specify next page in the li
st", |
| 1869 "location": "query", |
| 1870 "type": "string" |
| 1871 }, |
| 1872 "query": { |
| 1873 "description": "Query string search. Should be of th
e form \"\" where field can be any of supported fields, operators can be one of
'=' for exact match or ':' for prefix match. For prefix match, the value should
always be followed by a *.", |
| 1874 "location": "query", |
| 1875 "type": "string" |
| 1876 }, |
| 1877 "showDeleted": { |
| 1878 "description": "If set to true retrieves the list of
deleted users. Default is false", |
| 1879 "location": "query", |
| 1880 "type": "string" |
| 1881 }, |
| 1882 "sortOrder": { |
| 1883 "description": "Whether to return results in ascendi
ng or descending order.", |
| 1884 "enum": [ |
| 1885 "ASCENDING", |
| 1886 "DESCENDING" |
| 1887 ], |
| 1888 "enumDescriptions": [ |
| 1889 "Ascending order.", |
| 1890 "Descending order." |
| 1891 ], |
| 1892 "location": "query", |
| 1893 "type": "string" |
| 1894 } |
| 1895 }, |
| 1896 "path": "users/watch", |
| 1897 "request": { |
| 1898 "$ref": "Channel", |
| 1899 "parameterName": "resource" |
| 1900 }, |
| 1901 "response": { |
| 1902 "$ref": "Channel" |
| 1903 }, |
| 1904 "scopes": [ |
| 1905 "https://www.googleapis.com/auth/admin.directory.user", |
| 1906 "https://www.googleapis.com/auth/admin.directory.user.re
adonly" |
| 1907 ], |
| 1908 "supportsSubscription": true |
| 1909 } |
| 1910 }, |
| 1911 "resources": { |
| 1912 "aliases": { |
| 1913 "methods": { |
| 1914 "delete": { |
| 1915 "description": "Remove a alias for the user", |
| 1916 "httpMethod": "DELETE", |
| 1917 "id": "directory.users.aliases.delete", |
| 1918 "parameterOrder": [ |
| 1919 "userKey", |
| 1920 "alias" |
| 1921 ], |
| 1922 "parameters": { |
| 1923 "alias": { |
| 1924 "description": "The alias to be removed", |
| 1925 "location": "path", |
| 1926 "required": true, |
| 1927 "type": "string" |
| 1928 }, |
| 1929 "userKey": { |
| 1930 "description": "Email or immutable Id of the
user", |
| 1931 "location": "path", |
| 1932 "required": true, |
| 1933 "type": "string" |
| 1934 } |
| 1935 }, |
| 1936 "path": "users/{userKey}/aliases/{alias}", |
| 1937 "scopes": [ |
| 1938 "https://www.googleapis.com/auth/admin.directory
.user", |
| 1939 "https://www.googleapis.com/auth/admin.directory
.user.alias" |
| 1940 ] |
| 1941 }, |
| 1942 "insert": { |
| 1943 "description": "Add a alias for the user", |
| 1944 "httpMethod": "POST", |
| 1945 "id": "directory.users.aliases.insert", |
| 1946 "parameterOrder": [ |
| 1947 "userKey" |
| 1948 ], |
| 1949 "parameters": { |
| 1950 "userKey": { |
| 1951 "description": "Email or immutable Id of the
user", |
| 1952 "location": "path", |
| 1953 "required": true, |
| 1954 "type": "string" |
| 1955 } |
| 1956 }, |
| 1957 "path": "users/{userKey}/aliases", |
| 1958 "request": { |
| 1959 "$ref": "Alias" |
| 1960 }, |
| 1961 "response": { |
| 1962 "$ref": "Alias" |
| 1963 }, |
| 1964 "scopes": [ |
| 1965 "https://www.googleapis.com/auth/admin.directory
.user", |
| 1966 "https://www.googleapis.com/auth/admin.directory
.user.alias" |
| 1967 ] |
| 1968 }, |
| 1969 "list": { |
| 1970 "description": "List all aliases for a user", |
| 1971 "httpMethod": "GET", |
| 1972 "id": "directory.users.aliases.list", |
| 1973 "parameterOrder": [ |
| 1974 "userKey" |
| 1975 ], |
| 1976 "parameters": { |
| 1977 "event": { |
| 1978 "description": "Event on which subscription
is intended (if subscribing)", |
| 1979 "enum": [ |
| 1980 "add", |
| 1981 "delete" |
| 1982 ], |
| 1983 "enumDescriptions": [ |
| 1984 "Alias Created Event", |
| 1985 "Alias Deleted Event" |
| 1986 ], |
| 1987 "location": "query", |
| 1988 "type": "string" |
| 1989 }, |
| 1990 "userKey": { |
| 1991 "description": "Email or immutable Id of the
user", |
| 1992 "location": "path", |
| 1993 "required": true, |
| 1994 "type": "string" |
| 1995 } |
| 1996 }, |
| 1997 "path": "users/{userKey}/aliases", |
| 1998 "response": { |
| 1999 "$ref": "Aliases" |
| 2000 }, |
| 2001 "scopes": [ |
| 2002 "https://www.googleapis.com/auth/admin.directory
.user", |
| 2003 "https://www.googleapis.com/auth/admin.directory
.user.alias", |
| 2004 "https://www.googleapis.com/auth/admin.directory
.user.alias.readonly", |
| 2005 "https://www.googleapis.com/auth/admin.directory
.user.readonly" |
| 2006 ], |
| 2007 "supportsSubscription": true |
| 2008 }, |
| 2009 "watch": { |
| 2010 "description": "Watch for changes in user aliases li
st", |
| 2011 "httpMethod": "POST", |
| 2012 "id": "directory.users.aliases.watch", |
| 2013 "parameterOrder": [ |
| 2014 "userKey" |
| 2015 ], |
| 2016 "parameters": { |
| 2017 "event": { |
| 2018 "description": "Event on which subscription
is intended (if subscribing)", |
| 2019 "enum": [ |
| 2020 "add", |
| 2021 "delete" |
| 2022 ], |
| 2023 "enumDescriptions": [ |
| 2024 "Alias Created Event", |
| 2025 "Alias Deleted Event" |
| 2026 ], |
| 2027 "location": "query", |
| 2028 "type": "string" |
| 2029 }, |
| 2030 "userKey": { |
| 2031 "description": "Email or immutable Id of the
user", |
| 2032 "location": "path", |
| 2033 "required": true, |
| 2034 "type": "string" |
| 2035 } |
| 2036 }, |
| 2037 "path": "users/{userKey}/aliases/watch", |
| 2038 "request": { |
| 2039 "$ref": "Channel", |
| 2040 "parameterName": "resource" |
| 2041 }, |
| 2042 "response": { |
| 2043 "$ref": "Channel" |
| 2044 }, |
| 2045 "scopes": [ |
| 2046 "https://www.googleapis.com/auth/admin.directory
.user", |
| 2047 "https://www.googleapis.com/auth/admin.directory
.user.alias", |
| 2048 "https://www.googleapis.com/auth/admin.directory
.user.alias.readonly", |
| 2049 "https://www.googleapis.com/auth/admin.directory
.user.readonly" |
| 2050 ], |
| 2051 "supportsSubscription": true |
| 2052 } |
| 2053 } |
| 2054 }, |
| 2055 "photos": { |
| 2056 "methods": { |
| 2057 "delete": { |
| 2058 "description": "Remove photos for the user", |
| 2059 "httpMethod": "DELETE", |
| 2060 "id": "directory.users.photos.delete", |
| 2061 "parameterOrder": [ |
| 2062 "userKey" |
| 2063 ], |
| 2064 "parameters": { |
| 2065 "userKey": { |
| 2066 "description": "Email or immutable Id of the
user", |
| 2067 "location": "path", |
| 2068 "required": true, |
| 2069 "type": "string" |
| 2070 } |
| 2071 }, |
| 2072 "path": "users/{userKey}/photos/thumbnail", |
| 2073 "scopes": [ |
| 2074 "https://www.googleapis.com/auth/admin.directory
.user" |
| 2075 ] |
| 2076 }, |
| 2077 "get": { |
| 2078 "description": "Retrieve photo of a user", |
| 2079 "httpMethod": "GET", |
| 2080 "id": "directory.users.photos.get", |
| 2081 "parameterOrder": [ |
| 2082 "userKey" |
| 2083 ], |
| 2084 "parameters": { |
| 2085 "userKey": { |
| 2086 "description": "Email or immutable Id of the
user", |
| 2087 "location": "path", |
| 2088 "required": true, |
| 2089 "type": "string" |
| 2090 } |
| 2091 }, |
| 2092 "path": "users/{userKey}/photos/thumbnail", |
| 2093 "response": { |
| 2094 "$ref": "UserPhoto" |
| 2095 }, |
| 2096 "scopes": [ |
| 2097 "https://www.googleapis.com/auth/admin.directory
.user", |
| 2098 "https://www.googleapis.com/auth/admin.directory
.user.readonly" |
| 2099 ] |
| 2100 }, |
| 2101 "patch": { |
| 2102 "description": "Add a photo for the user. This metho
d supports patch semantics.", |
| 2103 "httpMethod": "PATCH", |
| 2104 "id": "directory.users.photos.patch", |
| 2105 "parameterOrder": [ |
| 2106 "userKey" |
| 2107 ], |
| 2108 "parameters": { |
| 2109 "userKey": { |
| 2110 "description": "Email or immutable Id of the
user", |
| 2111 "location": "path", |
| 2112 "required": true, |
| 2113 "type": "string" |
| 2114 } |
| 2115 }, |
| 2116 "path": "users/{userKey}/photos/thumbnail", |
| 2117 "request": { |
| 2118 "$ref": "UserPhoto" |
| 2119 }, |
| 2120 "response": { |
| 2121 "$ref": "UserPhoto" |
| 2122 }, |
| 2123 "scopes": [ |
| 2124 "https://www.googleapis.com/auth/admin.directory
.user" |
| 2125 ] |
| 2126 }, |
| 2127 "update": { |
| 2128 "description": "Add a photo for the user", |
| 2129 "httpMethod": "PUT", |
| 2130 "id": "directory.users.photos.update", |
| 2131 "parameterOrder": [ |
| 2132 "userKey" |
| 2133 ], |
| 2134 "parameters": { |
| 2135 "userKey": { |
| 2136 "description": "Email or immutable Id of the
user", |
| 2137 "location": "path", |
| 2138 "required": true, |
| 2139 "type": "string" |
| 2140 } |
| 2141 }, |
| 2142 "path": "users/{userKey}/photos/thumbnail", |
| 2143 "request": { |
| 2144 "$ref": "UserPhoto" |
| 2145 }, |
| 2146 "response": { |
| 2147 "$ref": "UserPhoto" |
| 2148 }, |
| 2149 "scopes": [ |
| 2150 "https://www.googleapis.com/auth/admin.directory
.user" |
| 2151 ] |
| 2152 } |
| 2153 } |
| 2154 } |
| 2155 } |
| 2156 }, |
| 2157 "verificationCodes": { |
| 2158 "methods": { |
| 2159 "generate": { |
| 2160 "description": "Generate new backup verification codes for t
he user.", |
| 2161 "httpMethod": "POST", |
| 2162 "id": "directory.verificationCodes.generate", |
| 2163 "parameterOrder": [ |
| 2164 "userKey" |
| 2165 ], |
| 2166 "parameters": { |
| 2167 "userKey": { |
| 2168 "description": "Email or immutable Id of the user", |
| 2169 "location": "path", |
| 2170 "required": true, |
| 2171 "type": "string" |
| 2172 } |
| 2173 }, |
| 2174 "path": "users/{userKey}/verificationCodes/generate", |
| 2175 "scopes": [ |
| 2176 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 2177 ] |
| 2178 }, |
| 2179 "invalidate": { |
| 2180 "description": "Invalidate the current backup verification c
odes for the user.", |
| 2181 "httpMethod": "POST", |
| 2182 "id": "directory.verificationCodes.invalidate", |
| 2183 "parameterOrder": [ |
| 2184 "userKey" |
| 2185 ], |
| 2186 "parameters": { |
| 2187 "userKey": { |
| 2188 "description": "Email or immutable Id of the user", |
| 2189 "location": "path", |
| 2190 "required": true, |
| 2191 "type": "string" |
| 2192 } |
| 2193 }, |
| 2194 "path": "users/{userKey}/verificationCodes/invalidate", |
| 2195 "scopes": [ |
| 2196 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 2197 ] |
| 2198 }, |
| 2199 "list": { |
| 2200 "description": "Returns the current set of valid backup veri
fication codes for the specified user.", |
| 2201 "httpMethod": "GET", |
| 2202 "id": "directory.verificationCodes.list", |
| 2203 "parameterOrder": [ |
| 2204 "userKey" |
| 2205 ], |
| 2206 "parameters": { |
| 2207 "userKey": { |
| 2208 "description": "Identifies the user in the API reque
st. The value can be the user's primary email address, alias email address, or u
nique user ID.", |
| 2209 "location": "path", |
| 2210 "required": true, |
| 2211 "type": "string" |
| 2212 } |
| 2213 }, |
| 2214 "path": "users/{userKey}/verificationCodes", |
| 2215 "response": { |
| 2216 "$ref": "VerificationCodes" |
| 2217 }, |
| 2218 "scopes": [ |
| 2219 "https://www.googleapis.com/auth/admin.directory.user.se
curity" |
| 2220 ] |
| 2221 } |
| 2222 } |
| 2223 } |
| 2224 }, |
| 2225 "revision": "20140905", |
| 2226 "rootUrl": "https://www.googleapis.com/", |
| 2227 "schemas": { |
| 2228 "Alias": { |
| 2229 "description": "JSON template for Alias object in Directory API.", |
| 2230 "id": "Alias", |
| 2231 "properties": { |
| 2232 "alias": { |
| 2233 "description": "A alias email", |
| 2234 "type": "string" |
| 2235 }, |
| 2236 "etag": { |
| 2237 "description": "ETag of the resource.", |
| 2238 "type": "string" |
| 2239 }, |
| 2240 "id": { |
| 2241 "description": "Unique id of the group (Read-only) Unique id
of the user (Read-only)", |
| 2242 "type": "string" |
| 2243 }, |
| 2244 "kind": { |
| 2245 "default": "admin#directory#alias", |
| 2246 "description": "Kind of resource this is.", |
| 2247 "type": "string" |
| 2248 }, |
| 2249 "primaryEmail": { |
| 2250 "description": "Group's primary email (Read-only) User's pri
mary email (Read-only)", |
| 2251 "type": "string" |
| 2252 } |
| 2253 }, |
| 2254 "type": "object" |
| 2255 }, |
| 2256 "Aliases": { |
| 2257 "description": "JSON response template to list aliases in Directory
API.", |
| 2258 "id": "Aliases", |
| 2259 "properties": { |
| 2260 "aliases": { |
| 2261 "description": "List of alias objects.", |
| 2262 "items": { |
| 2263 "$ref": "Alias" |
| 2264 }, |
| 2265 "type": "array" |
| 2266 }, |
| 2267 "etag": { |
| 2268 "description": "ETag of the resource.", |
| 2269 "type": "string" |
| 2270 }, |
| 2271 "kind": { |
| 2272 "default": "admin#directory#aliases", |
| 2273 "description": "Kind of resource this is.", |
| 2274 "type": "string" |
| 2275 } |
| 2276 }, |
| 2277 "type": "object" |
| 2278 }, |
| 2279 "Asp": { |
| 2280 "description": "The template that returns individual ASP (Access Cod
e) data.", |
| 2281 "id": "Asp", |
| 2282 "properties": { |
| 2283 "codeId": { |
| 2284 "description": "The unique ID of the ASP.", |
| 2285 "format": "int32", |
| 2286 "type": "integer" |
| 2287 }, |
| 2288 "creationTime": { |
| 2289 "description": "The time when the ASP was created. Expressed
in Unix time format.", |
| 2290 "format": "int64", |
| 2291 "type": "string" |
| 2292 }, |
| 2293 "etag": { |
| 2294 "description": "ETag of the ASP.", |
| 2295 "type": "string" |
| 2296 }, |
| 2297 "kind": { |
| 2298 "default": "admin#directory#asp", |
| 2299 "description": "The type of the API resource. This is always
admin#directory#asp.", |
| 2300 "type": "string" |
| 2301 }, |
| 2302 "lastTimeUsed": { |
| 2303 "description": "The time when the ASP was last used. Express
ed in Unix time format.", |
| 2304 "format": "int64", |
| 2305 "type": "string" |
| 2306 }, |
| 2307 "name": { |
| 2308 "description": "The name of the application that the user, r
epresented by their userId, entered when the ASP was created.", |
| 2309 "type": "string" |
| 2310 }, |
| 2311 "userKey": { |
| 2312 "description": "The unique ID of the user who issued the ASP
.", |
| 2313 "type": "string" |
| 2314 } |
| 2315 }, |
| 2316 "type": "object" |
| 2317 }, |
| 2318 "Asps": { |
| 2319 "id": "Asps", |
| 2320 "properties": { |
| 2321 "etag": { |
| 2322 "description": "ETag of the resource.", |
| 2323 "type": "string" |
| 2324 }, |
| 2325 "items": { |
| 2326 "description": "A list of ASP resources.", |
| 2327 "items": { |
| 2328 "$ref": "Asp" |
| 2329 }, |
| 2330 "type": "array" |
| 2331 }, |
| 2332 "kind": { |
| 2333 "default": "admin#directory#aspList", |
| 2334 "description": "The type of the API resource. This is always
admin#directory#aspList.", |
| 2335 "type": "string" |
| 2336 } |
| 2337 }, |
| 2338 "type": "object" |
| 2339 }, |
| 2340 "Channel": { |
| 2341 "description": "An notification channel used to watch for resource c
hanges.", |
| 2342 "id": "Channel", |
| 2343 "properties": { |
| 2344 "address": { |
| 2345 "description": "The address where notifications are delivere
d for this channel.", |
| 2346 "type": "string" |
| 2347 }, |
| 2348 "expiration": { |
| 2349 "description": "Date and time of notification channel expira
tion, expressed as a Unix timestamp, in milliseconds. Optional.", |
| 2350 "format": "int64", |
| 2351 "type": "string" |
| 2352 }, |
| 2353 "id": { |
| 2354 "description": "A UUID or similar unique string that identif
ies this channel.", |
| 2355 "type": "string" |
| 2356 }, |
| 2357 "kind": { |
| 2358 "default": "api#channel", |
| 2359 "description": "Identifies this as a notification channel us
ed to watch for changes to a resource. Value: the fixed string \"api#channel\"."
, |
| 2360 "type": "string" |
| 2361 }, |
| 2362 "params": { |
| 2363 "additionalProperties": { |
| 2364 "description": "Declares a new parameter by name.", |
| 2365 "type": "string" |
| 2366 }, |
| 2367 "description": "Additional parameters controlling delivery c
hannel behavior. Optional.", |
| 2368 "type": "object" |
| 2369 }, |
| 2370 "payload": { |
| 2371 "description": "A Boolean value to indicate whether payload
is wanted. Optional.", |
| 2372 "type": "boolean" |
| 2373 }, |
| 2374 "resourceId": { |
| 2375 "description": "An opaque ID that identifies the resource be
ing watched on this channel. Stable across different API versions.", |
| 2376 "type": "string" |
| 2377 }, |
| 2378 "resourceUri": { |
| 2379 "description": "A version-specific identifier for the watche
d resource.", |
| 2380 "type": "string" |
| 2381 }, |
| 2382 "token": { |
| 2383 "description": "An arbitrary string delivered to the target
address with each notification delivered over this channel. Optional.", |
| 2384 "type": "string" |
| 2385 }, |
| 2386 "type": { |
| 2387 "description": "The type of delivery mechanism used for this
channel.", |
| 2388 "type": "string" |
| 2389 } |
| 2390 }, |
| 2391 "type": "object" |
| 2392 }, |
| 2393 "ChromeOsDevice": { |
| 2394 "description": "JSON template for Chrome Os Device resource in Direc
tory API.", |
| 2395 "id": "ChromeOsDevice", |
| 2396 "properties": { |
| 2397 "annotatedLocation": { |
| 2398 "description": "Address or location of the device as noted b
y the administrator", |
| 2399 "type": "string" |
| 2400 }, |
| 2401 "annotatedUser": { |
| 2402 "description": "User of the device", |
| 2403 "type": "string" |
| 2404 }, |
| 2405 "bootMode": { |
| 2406 "description": "Chromebook boot mode (Read-only)", |
| 2407 "type": "string" |
| 2408 }, |
| 2409 "deviceId": { |
| 2410 "description": "Unique identifier of Chrome OS Device (Read-
only)", |
| 2411 "type": "string" |
| 2412 }, |
| 2413 "etag": { |
| 2414 "description": "ETag of the resource.", |
| 2415 "type": "string" |
| 2416 }, |
| 2417 "ethernetMacAddress": { |
| 2418 "description": "Chromebook Mac Address on ethernet network i
nterface (Read-only)", |
| 2419 "type": "string" |
| 2420 }, |
| 2421 "firmwareVersion": { |
| 2422 "description": "Chromebook firmware version (Read-only)", |
| 2423 "type": "string" |
| 2424 }, |
| 2425 "kind": { |
| 2426 "default": "admin#directory#chromeosdevice", |
| 2427 "description": "Kind of resource this is.", |
| 2428 "type": "string" |
| 2429 }, |
| 2430 "lastEnrollmentTime": { |
| 2431 "description": "Date and time the device was last enrolled (
Read-only)", |
| 2432 "format": "date-time", |
| 2433 "type": "string" |
| 2434 }, |
| 2435 "lastSync": { |
| 2436 "description": "Date and time the device was last synchroniz
ed with the policy settings in the Google Apps administrator control panel (Read
-only)", |
| 2437 "format": "date-time", |
| 2438 "type": "string" |
| 2439 }, |
| 2440 "macAddress": { |
| 2441 "description": "Chromebook Mac Address on wifi network inter
face (Read-only)", |
| 2442 "type": "string" |
| 2443 }, |
| 2444 "meid": { |
| 2445 "description": "Mobile Equipment identifier for the 3G mobil
e card in the Chromebook (Read-only)", |
| 2446 "type": "string" |
| 2447 }, |
| 2448 "model": { |
| 2449 "description": "Chromebook Model (Read-only)", |
| 2450 "type": "string" |
| 2451 }, |
| 2452 "notes": { |
| 2453 "description": "Notes added by the administrator", |
| 2454 "type": "string" |
| 2455 }, |
| 2456 "orderNumber": { |
| 2457 "description": "Chromebook order number (Read-only)", |
| 2458 "type": "string" |
| 2459 }, |
| 2460 "orgUnitPath": { |
| 2461 "description": "OrgUnit of the device", |
| 2462 "type": "string" |
| 2463 }, |
| 2464 "osVersion": { |
| 2465 "description": "Chromebook Os Version (Read-only)", |
| 2466 "type": "string" |
| 2467 }, |
| 2468 "platformVersion": { |
| 2469 "description": "Chromebook platform version (Read-only)", |
| 2470 "type": "string" |
| 2471 }, |
| 2472 "recentUsers": { |
| 2473 "description": "List of recent device users, in descending o
rder by last login time (Read-only)", |
| 2474 "items": { |
| 2475 "properties": { |
| 2476 "email": { |
| 2477 "description": "Email address of the user. Prese
nt only if the user type is managed", |
| 2478 "type": "string" |
| 2479 }, |
| 2480 "type": { |
| 2481 "description": "The type of the user", |
| 2482 "type": "string" |
| 2483 } |
| 2484 }, |
| 2485 "type": "object" |
| 2486 }, |
| 2487 "type": "array" |
| 2488 }, |
| 2489 "serialNumber": { |
| 2490 "description": "Chromebook serial number (Read-only)", |
| 2491 "type": "string" |
| 2492 }, |
| 2493 "status": { |
| 2494 "description": "status of the device (Read-only)", |
| 2495 "type": "string" |
| 2496 }, |
| 2497 "supportEndDate": { |
| 2498 "description": "Final date the device will be supported (Rea
d-only)", |
| 2499 "format": "date-time", |
| 2500 "type": "string" |
| 2501 }, |
| 2502 "willAutoRenew": { |
| 2503 "description": "Will Chromebook auto renew after support end
date (Read-only)", |
| 2504 "type": "boolean" |
| 2505 } |
| 2506 }, |
| 2507 "type": "object" |
| 2508 }, |
| 2509 "ChromeOsDevices": { |
| 2510 "description": "JSON response template for List Chrome OS Devices op
eration in Directory API.", |
| 2511 "id": "ChromeOsDevices", |
| 2512 "properties": { |
| 2513 "chromeosdevices": { |
| 2514 "description": "List of Chrome OS Device objects.", |
| 2515 "items": { |
| 2516 "$ref": "ChromeOsDevice" |
| 2517 }, |
| 2518 "type": "array" |
| 2519 }, |
| 2520 "etag": { |
| 2521 "description": "ETag of the resource.", |
| 2522 "type": "string" |
| 2523 }, |
| 2524 "kind": { |
| 2525 "default": "admin#directory#chromeosdevices", |
| 2526 "description": "Kind of resource this is.", |
| 2527 "type": "string" |
| 2528 }, |
| 2529 "nextPageToken": { |
| 2530 "description": "Token used to access next page of this resul
t.", |
| 2531 "type": "string" |
| 2532 } |
| 2533 }, |
| 2534 "type": "object" |
| 2535 }, |
| 2536 "Group": { |
| 2537 "description": "JSON template for Group resource in Directory API.", |
| 2538 "id": "Group", |
| 2539 "properties": { |
| 2540 "adminCreated": { |
| 2541 "description": "Is the group created by admin (Read-only) *"
, |
| 2542 "type": "boolean" |
| 2543 }, |
| 2544 "aliases": { |
| 2545 "description": "List of aliases (Read-only)", |
| 2546 "items": { |
| 2547 "type": "string" |
| 2548 }, |
| 2549 "type": "array" |
| 2550 }, |
| 2551 "description": { |
| 2552 "description": "Description of the group", |
| 2553 "type": "string" |
| 2554 }, |
| 2555 "directMembersCount": { |
| 2556 "description": "Group direct members count", |
| 2557 "format": "int64", |
| 2558 "type": "string" |
| 2559 }, |
| 2560 "email": { |
| 2561 "annotations": { |
| 2562 "required": [ |
| 2563 "directory.groups.insert" |
| 2564 ] |
| 2565 }, |
| 2566 "description": "Email of Group", |
| 2567 "type": "string" |
| 2568 }, |
| 2569 "etag": { |
| 2570 "description": "ETag of the resource.", |
| 2571 "type": "string" |
| 2572 }, |
| 2573 "id": { |
| 2574 "description": "Unique identifier of Group (Read-only)", |
| 2575 "type": "string" |
| 2576 }, |
| 2577 "kind": { |
| 2578 "default": "admin#directory#group", |
| 2579 "description": "Kind of resource this is.", |
| 2580 "type": "string" |
| 2581 }, |
| 2582 "name": { |
| 2583 "description": "Group name", |
| 2584 "type": "string" |
| 2585 }, |
| 2586 "nonEditableAliases": { |
| 2587 "description": "List of non editable aliases (Read-only)", |
| 2588 "items": { |
| 2589 "type": "string" |
| 2590 }, |
| 2591 "type": "array" |
| 2592 } |
| 2593 }, |
| 2594 "type": "object" |
| 2595 }, |
| 2596 "Groups": { |
| 2597 "description": "JSON response template for List Groups operation in
Directory API.", |
| 2598 "id": "Groups", |
| 2599 "properties": { |
| 2600 "etag": { |
| 2601 "description": "ETag of the resource.", |
| 2602 "type": "string" |
| 2603 }, |
| 2604 "groups": { |
| 2605 "description": "List of group objects.", |
| 2606 "items": { |
| 2607 "$ref": "Group" |
| 2608 }, |
| 2609 "type": "array" |
| 2610 }, |
| 2611 "kind": { |
| 2612 "default": "admin#directory#groups", |
| 2613 "description": "Kind of resource this is.", |
| 2614 "type": "string" |
| 2615 }, |
| 2616 "nextPageToken": { |
| 2617 "description": "Token used to access next page of this resul
t.", |
| 2618 "type": "string" |
| 2619 } |
| 2620 }, |
| 2621 "type": "object" |
| 2622 }, |
| 2623 "Member": { |
| 2624 "description": "JSON template for Member resource in Directory API."
, |
| 2625 "id": "Member", |
| 2626 "properties": { |
| 2627 "email": { |
| 2628 "description": "Email of member (Read-only)", |
| 2629 "type": "string" |
| 2630 }, |
| 2631 "etag": { |
| 2632 "description": "ETag of the resource.", |
| 2633 "type": "string" |
| 2634 }, |
| 2635 "id": { |
| 2636 "description": "Unique identifier of customer member (Read-o
nly) Unique identifier of group (Read-only) Unique identifier of member (Read-on
ly)", |
| 2637 "type": "string" |
| 2638 }, |
| 2639 "kind": { |
| 2640 "default": "admin#directory#member", |
| 2641 "description": "Kind of resource this is.", |
| 2642 "type": "string" |
| 2643 }, |
| 2644 "role": { |
| 2645 "description": "Role of member", |
| 2646 "type": "string" |
| 2647 }, |
| 2648 "type": { |
| 2649 "description": "Type of member (Immutable)", |
| 2650 "type": "string" |
| 2651 } |
| 2652 }, |
| 2653 "type": "object" |
| 2654 }, |
| 2655 "Members": { |
| 2656 "description": "JSON response template for List Members operation in
Directory API.", |
| 2657 "id": "Members", |
| 2658 "properties": { |
| 2659 "etag": { |
| 2660 "description": "ETag of the resource.", |
| 2661 "type": "string" |
| 2662 }, |
| 2663 "kind": { |
| 2664 "default": "admin#directory#members", |
| 2665 "description": "Kind of resource this is.", |
| 2666 "type": "string" |
| 2667 }, |
| 2668 "members": { |
| 2669 "description": "List of member objects.", |
| 2670 "items": { |
| 2671 "$ref": "Member" |
| 2672 }, |
| 2673 "type": "array" |
| 2674 }, |
| 2675 "nextPageToken": { |
| 2676 "description": "Token used to access next page of this resul
t.", |
| 2677 "type": "string" |
| 2678 } |
| 2679 }, |
| 2680 "type": "object" |
| 2681 }, |
| 2682 "MobileDevice": { |
| 2683 "description": "JSON template for Mobile Device resource in Director
y API.", |
| 2684 "id": "MobileDevice", |
| 2685 "properties": { |
| 2686 "applications": { |
| 2687 "description": "List of applications installed on Mobile Dev
ice", |
| 2688 "items": { |
| 2689 "properties": { |
| 2690 "displayName": { |
| 2691 "description": "Display name of application", |
| 2692 "type": "string" |
| 2693 }, |
| 2694 "packageName": { |
| 2695 "description": "Package name of application", |
| 2696 "type": "string" |
| 2697 }, |
| 2698 "permission": { |
| 2699 "description": "List of Permissions for applicat
ion", |
| 2700 "items": { |
| 2701 "type": "string" |
| 2702 }, |
| 2703 "type": "array" |
| 2704 }, |
| 2705 "versionCode": { |
| 2706 "description": "Version code of application", |
| 2707 "format": "int32", |
| 2708 "type": "integer" |
| 2709 }, |
| 2710 "versionName": { |
| 2711 "description": "Version name of application", |
| 2712 "type": "string" |
| 2713 } |
| 2714 }, |
| 2715 "type": "object" |
| 2716 }, |
| 2717 "type": "array" |
| 2718 }, |
| 2719 "basebandVersion": { |
| 2720 "description": "Mobile Device Baseband version (Read-only)", |
| 2721 "type": "string" |
| 2722 }, |
| 2723 "buildNumber": { |
| 2724 "description": "Mobile Device Build number (Read-only)", |
| 2725 "type": "string" |
| 2726 }, |
| 2727 "defaultLanguage": { |
| 2728 "description": "The default locale used on the Mobile Device
(Read-only)", |
| 2729 "type": "string" |
| 2730 }, |
| 2731 "deviceCompromisedStatus": { |
| 2732 "description": "Mobile Device compromised status (Read-only)
", |
| 2733 "type": "string" |
| 2734 }, |
| 2735 "deviceId": { |
| 2736 "description": "Mobile Device serial number (Read-only)", |
| 2737 "type": "string" |
| 2738 }, |
| 2739 "email": { |
| 2740 "description": "List of owner user's email addresses (Read-o
nly)", |
| 2741 "items": { |
| 2742 "type": "string" |
| 2743 }, |
| 2744 "type": "array" |
| 2745 }, |
| 2746 "etag": { |
| 2747 "description": "ETag of the resource.", |
| 2748 "type": "string" |
| 2749 }, |
| 2750 "firstSync": { |
| 2751 "description": "Date and time the device was first synchroni
zed with the policy settings in the Google Apps administrator control panel (Rea
d-only)", |
| 2752 "format": "date-time", |
| 2753 "type": "string" |
| 2754 }, |
| 2755 "hardwareId": { |
| 2756 "description": "Mobile Device Hardware Id (Read-only)", |
| 2757 "type": "string" |
| 2758 }, |
| 2759 "imei": { |
| 2760 "description": "Mobile Device IMEI number (Read-only)", |
| 2761 "type": "string" |
| 2762 }, |
| 2763 "kernelVersion": { |
| 2764 "description": "Mobile Device Kernel version (Read-only)", |
| 2765 "type": "string" |
| 2766 }, |
| 2767 "kind": { |
| 2768 "default": "admin#directory#mobiledevice", |
| 2769 "description": "Kind of resource this is.", |
| 2770 "type": "string" |
| 2771 }, |
| 2772 "lastSync": { |
| 2773 "description": "Date and time the device was last synchroniz
ed with the policy settings in the Google Apps administrator control panel (Read
-only)", |
| 2774 "format": "date-time", |
| 2775 "type": "string" |
| 2776 }, |
| 2777 "managedAccountIsOnOwnerProfile": { |
| 2778 "description": "Boolean indicating if this account is on own
er/primary profile or not (Read-only)", |
| 2779 "type": "boolean" |
| 2780 }, |
| 2781 "meid": { |
| 2782 "description": "Mobile Device MEID number (Read-only)", |
| 2783 "type": "string" |
| 2784 }, |
| 2785 "model": { |
| 2786 "description": "Name of the model of the device", |
| 2787 "type": "string" |
| 2788 }, |
| 2789 "name": { |
| 2790 "description": "List of owner user's names (Read-only)", |
| 2791 "items": { |
| 2792 "type": "string" |
| 2793 }, |
| 2794 "type": "array" |
| 2795 }, |
| 2796 "networkOperator": { |
| 2797 "description": "Mobile Device mobile or network operator (if
available) (Read-only)", |
| 2798 "type": "string" |
| 2799 }, |
| 2800 "os": { |
| 2801 "description": "Name of the mobile operating system", |
| 2802 "type": "string" |
| 2803 }, |
| 2804 "resourceId": { |
| 2805 "description": "Unique identifier of Mobile Device (Read-onl
y)", |
| 2806 "type": "string" |
| 2807 }, |
| 2808 "serialNumber": { |
| 2809 "description": "Mobile Device SSN or Serial Number (Read-onl
y)", |
| 2810 "type": "string" |
| 2811 }, |
| 2812 "status": { |
| 2813 "description": "Status of the device (Read-only)", |
| 2814 "type": "string" |
| 2815 }, |
| 2816 "type": { |
| 2817 "description": "The type of device (Read-only)", |
| 2818 "type": "string" |
| 2819 }, |
| 2820 "userAgent": { |
| 2821 "description": "Mobile Device user agent", |
| 2822 "type": "string" |
| 2823 }, |
| 2824 "wifiMacAddress": { |
| 2825 "description": "Mobile Device WiFi MAC address (Read-only)", |
| 2826 "type": "string" |
| 2827 } |
| 2828 }, |
| 2829 "type": "object" |
| 2830 }, |
| 2831 "MobileDeviceAction": { |
| 2832 "description": "JSON request template for firing commands on Mobile
Device in Directory Devices API.", |
| 2833 "id": "MobileDeviceAction", |
| 2834 "properties": { |
| 2835 "action": { |
| 2836 "annotations": { |
| 2837 "required": [ |
| 2838 "directory.mobiledevices.action" |
| 2839 ] |
| 2840 }, |
| 2841 "description": "Action to be taken on the Mobile Device", |
| 2842 "type": "string" |
| 2843 } |
| 2844 }, |
| 2845 "type": "object" |
| 2846 }, |
| 2847 "MobileDevices": { |
| 2848 "description": "JSON response template for List Mobile Devices opera
tion in Directory API.", |
| 2849 "id": "MobileDevices", |
| 2850 "properties": { |
| 2851 "etag": { |
| 2852 "description": "ETag of the resource.", |
| 2853 "type": "string" |
| 2854 }, |
| 2855 "kind": { |
| 2856 "default": "admin#directory#mobiledevices", |
| 2857 "description": "Kind of resource this is.", |
| 2858 "type": "string" |
| 2859 }, |
| 2860 "mobiledevices": { |
| 2861 "description": "List of Mobile Device objects.", |
| 2862 "items": { |
| 2863 "$ref": "MobileDevice" |
| 2864 }, |
| 2865 "type": "array" |
| 2866 }, |
| 2867 "nextPageToken": { |
| 2868 "description": "Token used to access next page of this resul
t.", |
| 2869 "type": "string" |
| 2870 } |
| 2871 }, |
| 2872 "type": "object" |
| 2873 }, |
| 2874 "Notification": { |
| 2875 "description": "Template for a notification resource.", |
| 2876 "id": "Notification", |
| 2877 "properties": { |
| 2878 "body": { |
| 2879 "description": "Body of the notification (Read-only)", |
| 2880 "type": "string" |
| 2881 }, |
| 2882 "etag": { |
| 2883 "description": "ETag of the resource.", |
| 2884 "type": "string" |
| 2885 }, |
| 2886 "fromAddress": { |
| 2887 "description": "Address from which the notification is recei
ved (Read-only)", |
| 2888 "type": "string" |
| 2889 }, |
| 2890 "isUnread": { |
| 2891 "annotations": { |
| 2892 "required": [ |
| 2893 "directory.notifications.patch", |
| 2894 "directory.notifications.update" |
| 2895 ] |
| 2896 }, |
| 2897 "description": "Boolean indicating whether the notification
is unread or not.", |
| 2898 "type": "boolean" |
| 2899 }, |
| 2900 "kind": { |
| 2901 "default": "admin#directory#notification", |
| 2902 "description": "The type of the resource.", |
| 2903 "type": "string" |
| 2904 }, |
| 2905 "notificationId": { |
| 2906 "type": "string" |
| 2907 }, |
| 2908 "sendTime": { |
| 2909 "description": "Time at which notification was sent (Read-on
ly)", |
| 2910 "format": "date-time", |
| 2911 "type": "string" |
| 2912 }, |
| 2913 "subject": { |
| 2914 "description": "Subject of the notification (Read-only)", |
| 2915 "type": "string" |
| 2916 } |
| 2917 }, |
| 2918 "type": "object" |
| 2919 }, |
| 2920 "Notifications": { |
| 2921 "description": "Template for notifications list response.", |
| 2922 "id": "Notifications", |
| 2923 "properties": { |
| 2924 "etag": { |
| 2925 "description": "ETag of the resource.", |
| 2926 "type": "string" |
| 2927 }, |
| 2928 "items": { |
| 2929 "description": "List of notifications in this page.", |
| 2930 "items": { |
| 2931 "$ref": "Notification" |
| 2932 }, |
| 2933 "type": "array" |
| 2934 }, |
| 2935 "kind": { |
| 2936 "default": "admin#directory#notifications", |
| 2937 "description": "The type of the resource.", |
| 2938 "type": "string" |
| 2939 }, |
| 2940 "nextPageToken": { |
| 2941 "description": "Token for fetching the next page of notifica
tions.", |
| 2942 "type": "string" |
| 2943 }, |
| 2944 "unreadNotificationsCount": { |
| 2945 "description": "Number of unread notification for the domain
.", |
| 2946 "format": "int32", |
| 2947 "type": "integer" |
| 2948 } |
| 2949 }, |
| 2950 "type": "object" |
| 2951 }, |
| 2952 "OrgUnit": { |
| 2953 "description": "JSON template for Org Unit resource in Directory API
.", |
| 2954 "id": "OrgUnit", |
| 2955 "properties": { |
| 2956 "blockInheritance": { |
| 2957 "description": "Should block inheritance", |
| 2958 "type": "boolean" |
| 2959 }, |
| 2960 "description": { |
| 2961 "description": "Description of OrgUnit", |
| 2962 "type": "string" |
| 2963 }, |
| 2964 "etag": { |
| 2965 "description": "ETag of the resource.", |
| 2966 "type": "string" |
| 2967 }, |
| 2968 "kind": { |
| 2969 "default": "admin#directory#orgUnit", |
| 2970 "description": "Kind of resource this is.", |
| 2971 "type": "string" |
| 2972 }, |
| 2973 "name": { |
| 2974 "annotations": { |
| 2975 "required": [ |
| 2976 "directory.orgunits.insert" |
| 2977 ] |
| 2978 }, |
| 2979 "description": "Name of OrgUnit", |
| 2980 "type": "string" |
| 2981 }, |
| 2982 "orgUnitPath": { |
| 2983 "description": "Path of OrgUnit", |
| 2984 "type": "string" |
| 2985 }, |
| 2986 "parentOrgUnitPath": { |
| 2987 "annotations": { |
| 2988 "required": [ |
| 2989 "directory.orgunits.insert" |
| 2990 ] |
| 2991 }, |
| 2992 "description": "Path of parent OrgUnit", |
| 2993 "type": "string" |
| 2994 } |
| 2995 }, |
| 2996 "type": "object" |
| 2997 }, |
| 2998 "OrgUnits": { |
| 2999 "description": "JSON response template for List Organization Units o
peration in Directory API.", |
| 3000 "id": "OrgUnits", |
| 3001 "properties": { |
| 3002 "etag": { |
| 3003 "description": "ETag of the resource.", |
| 3004 "type": "string" |
| 3005 }, |
| 3006 "kind": { |
| 3007 "default": "admin#directory#orgUnits", |
| 3008 "description": "Kind of resource this is.", |
| 3009 "type": "string" |
| 3010 }, |
| 3011 "organizationUnits": { |
| 3012 "description": "List of user objects.", |
| 3013 "items": { |
| 3014 "$ref": "OrgUnit" |
| 3015 }, |
| 3016 "type": "array" |
| 3017 } |
| 3018 }, |
| 3019 "type": "object" |
| 3020 }, |
| 3021 "Token": { |
| 3022 "description": "JSON template for token resource in Directory API.", |
| 3023 "id": "Token", |
| 3024 "properties": { |
| 3025 "anonymous": { |
| 3026 "description": "Whether the application is registered with G
oogle. The value is true if the application has an anonymous Client ID.", |
| 3027 "type": "boolean" |
| 3028 }, |
| 3029 "clientId": { |
| 3030 "description": "The Client ID of the application the token i
s issued to.", |
| 3031 "type": "string" |
| 3032 }, |
| 3033 "displayText": { |
| 3034 "description": "The displayable name of the application the
token is issued to.", |
| 3035 "type": "string" |
| 3036 }, |
| 3037 "etag": { |
| 3038 "description": "ETag of the resource.", |
| 3039 "type": "string" |
| 3040 }, |
| 3041 "kind": { |
| 3042 "default": "admin#directory#token", |
| 3043 "description": "The type of the API resource. This is always
admin#directory#token.", |
| 3044 "type": "string" |
| 3045 }, |
| 3046 "nativeApp": { |
| 3047 "description": "Whether the token is issued to an installed
application. The value is true if the application is installed to a desktop or m
obile device.", |
| 3048 "type": "boolean" |
| 3049 }, |
| 3050 "scopes": { |
| 3051 "description": "A list of authorization scopes the applicati
on is granted.", |
| 3052 "items": { |
| 3053 "type": "string" |
| 3054 }, |
| 3055 "type": "array" |
| 3056 }, |
| 3057 "userKey": { |
| 3058 "description": "The unique ID of the user that issued the to
ken.", |
| 3059 "type": "string" |
| 3060 } |
| 3061 }, |
| 3062 "type": "object" |
| 3063 }, |
| 3064 "Tokens": { |
| 3065 "description": "JSON response template for List tokens operation in
Directory API.", |
| 3066 "id": "Tokens", |
| 3067 "properties": { |
| 3068 "etag": { |
| 3069 "description": "ETag of the resource.", |
| 3070 "type": "string" |
| 3071 }, |
| 3072 "items": { |
| 3073 "description": "A list of Token resources.", |
| 3074 "items": { |
| 3075 "$ref": "Token" |
| 3076 }, |
| 3077 "type": "array" |
| 3078 }, |
| 3079 "kind": { |
| 3080 "default": "admin#directory#tokenList", |
| 3081 "description": "The type of the API resource. This is always
admin#directory#tokenList.", |
| 3082 "type": "string" |
| 3083 } |
| 3084 }, |
| 3085 "type": "object" |
| 3086 }, |
| 3087 "User": { |
| 3088 "description": "JSON template for User object in Apps Directory API.
", |
| 3089 "id": "User", |
| 3090 "properties": { |
| 3091 "addresses": { |
| 3092 "type": "any" |
| 3093 }, |
| 3094 "agreedToTerms": { |
| 3095 "description": "Indicates if user has agreed to terms (Read-
only)", |
| 3096 "type": "boolean" |
| 3097 }, |
| 3098 "aliases": { |
| 3099 "description": "List of aliases (Read-only)", |
| 3100 "items": { |
| 3101 "type": "string" |
| 3102 }, |
| 3103 "type": "array" |
| 3104 }, |
| 3105 "changePasswordAtNextLogin": { |
| 3106 "description": "Boolean indicating if the user should change
password in next login", |
| 3107 "type": "boolean" |
| 3108 }, |
| 3109 "creationTime": { |
| 3110 "description": "User's Google account creation time. (Read-o
nly)", |
| 3111 "format": "date-time", |
| 3112 "type": "string" |
| 3113 }, |
| 3114 "customerId": { |
| 3115 "description": "CustomerId of User (Read-only)", |
| 3116 "type": "string" |
| 3117 }, |
| 3118 "deletionTime": { |
| 3119 "format": "date-time", |
| 3120 "type": "string" |
| 3121 }, |
| 3122 "emails": { |
| 3123 "type": "any" |
| 3124 }, |
| 3125 "etag": { |
| 3126 "description": "ETag of the resource.", |
| 3127 "type": "string" |
| 3128 }, |
| 3129 "externalIds": { |
| 3130 "type": "any" |
| 3131 }, |
| 3132 "hashFunction": { |
| 3133 "description": "Hash function name for password. Supported a
re MD5, SHA-1 and crypt", |
| 3134 "type": "string" |
| 3135 }, |
| 3136 "id": { |
| 3137 "description": "Unique identifier of User (Read-only)", |
| 3138 "type": "string" |
| 3139 }, |
| 3140 "ims": { |
| 3141 "type": "any" |
| 3142 }, |
| 3143 "includeInGlobalAddressList": { |
| 3144 "description": "Boolean indicating if user is included in Gl
obal Address List", |
| 3145 "type": "boolean" |
| 3146 }, |
| 3147 "ipWhitelisted": { |
| 3148 "description": "Boolean indicating if ip is whitelisted", |
| 3149 "type": "boolean" |
| 3150 }, |
| 3151 "isAdmin": { |
| 3152 "description": "Boolean indicating if the user is admin (Rea
d-only)", |
| 3153 "type": "boolean" |
| 3154 }, |
| 3155 "isDelegatedAdmin": { |
| 3156 "description": "Boolean indicating if the user is delegated
admin (Read-only)", |
| 3157 "type": "boolean" |
| 3158 }, |
| 3159 "isMailboxSetup": { |
| 3160 "description": "Is mailbox setup (Read-only)", |
| 3161 "type": "boolean" |
| 3162 }, |
| 3163 "kind": { |
| 3164 "default": "admin#directory#user", |
| 3165 "description": "Kind of resource this is.", |
| 3166 "type": "string" |
| 3167 }, |
| 3168 "lastLoginTime": { |
| 3169 "description": "User's last login time. (Read-only)", |
| 3170 "format": "date-time", |
| 3171 "type": "string" |
| 3172 }, |
| 3173 "name": { |
| 3174 "$ref": "UserName", |
| 3175 "annotations": { |
| 3176 "required": [ |
| 3177 "directory.users.insert" |
| 3178 ] |
| 3179 }, |
| 3180 "description": "User's name" |
| 3181 }, |
| 3182 "nonEditableAliases": { |
| 3183 "description": "List of non editable aliases (Read-only)", |
| 3184 "items": { |
| 3185 "type": "string" |
| 3186 }, |
| 3187 "type": "array" |
| 3188 }, |
| 3189 "orgUnitPath": { |
| 3190 "description": "OrgUnit of User", |
| 3191 "type": "string" |
| 3192 }, |
| 3193 "organizations": { |
| 3194 "type": "any" |
| 3195 }, |
| 3196 "password": { |
| 3197 "annotations": { |
| 3198 "required": [ |
| 3199 "directory.users.insert" |
| 3200 ] |
| 3201 }, |
| 3202 "description": "User's password", |
| 3203 "type": "string" |
| 3204 }, |
| 3205 "phones": { |
| 3206 "type": "any" |
| 3207 }, |
| 3208 "primaryEmail": { |
| 3209 "annotations": { |
| 3210 "required": [ |
| 3211 "directory.users.insert" |
| 3212 ] |
| 3213 }, |
| 3214 "description": "username of User", |
| 3215 "type": "string" |
| 3216 }, |
| 3217 "relations": { |
| 3218 "type": "any" |
| 3219 }, |
| 3220 "suspended": { |
| 3221 "description": "Indicates if user is suspended", |
| 3222 "type": "boolean" |
| 3223 }, |
| 3224 "suspensionReason": { |
| 3225 "description": "Suspension reason if user is suspended (Read
-only)", |
| 3226 "type": "string" |
| 3227 }, |
| 3228 "thumbnailPhotoUrl": { |
| 3229 "description": "Photo Url of the user (Read-only)", |
| 3230 "type": "string" |
| 3231 } |
| 3232 }, |
| 3233 "type": "object" |
| 3234 }, |
| 3235 "UserAddress": { |
| 3236 "description": "JSON template for address.", |
| 3237 "id": "UserAddress", |
| 3238 "properties": { |
| 3239 "country": { |
| 3240 "description": "Country.", |
| 3241 "type": "string" |
| 3242 }, |
| 3243 "countryCode": { |
| 3244 "description": "Country code.", |
| 3245 "type": "string" |
| 3246 }, |
| 3247 "customType": { |
| 3248 "description": "Custom type.", |
| 3249 "type": "string" |
| 3250 }, |
| 3251 "extendedAddress": { |
| 3252 "description": "Extended Address.", |
| 3253 "type": "string" |
| 3254 }, |
| 3255 "formatted": { |
| 3256 "description": "Formatted address (read-only field)", |
| 3257 "type": "string" |
| 3258 }, |
| 3259 "locality": { |
| 3260 "description": "Locality.", |
| 3261 "type": "string" |
| 3262 }, |
| 3263 "poBox": { |
| 3264 "description": "Other parts of address.", |
| 3265 "type": "string" |
| 3266 }, |
| 3267 "postalCode": { |
| 3268 "description": "Postal code.", |
| 3269 "type": "string" |
| 3270 }, |
| 3271 "primary": { |
| 3272 "description": "If this is user's primary address. Only one
entry could be marked as primary.", |
| 3273 "type": "boolean" |
| 3274 }, |
| 3275 "region": { |
| 3276 "description": "Region.", |
| 3277 "type": "string" |
| 3278 }, |
| 3279 "sourceIsStructured": { |
| 3280 "description": "User supplied address was structured. Struct
ured addresses are NOT supported at this time. You might be able to write struct
ured addresses, but any values will eventually be clobbered.", |
| 3281 "type": "boolean" |
| 3282 }, |
| 3283 "streetAddress": { |
| 3284 "description": "Street.", |
| 3285 "type": "string" |
| 3286 }, |
| 3287 "type": { |
| 3288 "description": "Each entry can have a type which indicates s
tandard values of that entry. For example address could be of home, work etc. In
addition to the standard type, an entry can have a custom type and can take any
value. Such type should have the CUSTOM value as type and also have a customTyp
e value.", |
| 3289 "type": "string" |
| 3290 } |
| 3291 }, |
| 3292 "type": "object" |
| 3293 }, |
| 3294 "UserEmail": { |
| 3295 "description": "JSON template for an email.", |
| 3296 "id": "UserEmail", |
| 3297 "properties": { |
| 3298 "address": { |
| 3299 "description": "Email id of the user.", |
| 3300 "type": "string" |
| 3301 }, |
| 3302 "customType": { |
| 3303 "description": "Custom Type.", |
| 3304 "type": "string" |
| 3305 }, |
| 3306 "primary": { |
| 3307 "description": "If this is user's primary email. Only one en
try could be marked as primary.", |
| 3308 "type": "boolean" |
| 3309 }, |
| 3310 "type": { |
| 3311 "description": "Each entry can have a type which indicates s
tandard types of that entry. For example email could be of home, work etc. In ad
dition to the standard type, an entry can have a custom type and can take any va
lue Such types should have the CUSTOM value as type and also have a customType v
alue.", |
| 3312 "type": "string" |
| 3313 } |
| 3314 }, |
| 3315 "type": "object" |
| 3316 }, |
| 3317 "UserExternalId": { |
| 3318 "description": "JSON template for an externalId entry.", |
| 3319 "id": "UserExternalId", |
| 3320 "properties": { |
| 3321 "customType": { |
| 3322 "description": "Custom type.", |
| 3323 "type": "string" |
| 3324 }, |
| 3325 "type": { |
| 3326 "description": "The type of the Id.", |
| 3327 "type": "string" |
| 3328 }, |
| 3329 "value": { |
| 3330 "description": "The value of the id.", |
| 3331 "type": "string" |
| 3332 } |
| 3333 }, |
| 3334 "type": "object" |
| 3335 }, |
| 3336 "UserIm": { |
| 3337 "description": "JSON template for instant messenger of an user.", |
| 3338 "id": "UserIm", |
| 3339 "properties": { |
| 3340 "customProtocol": { |
| 3341 "description": "Custom protocol.", |
| 3342 "type": "string" |
| 3343 }, |
| 3344 "customType": { |
| 3345 "description": "Custom type.", |
| 3346 "type": "string" |
| 3347 }, |
| 3348 "im": { |
| 3349 "description": "Instant messenger id.", |
| 3350 "type": "string" |
| 3351 }, |
| 3352 "primary": { |
| 3353 "description": "If this is user's primary im. Only one entry
could be marked as primary.", |
| 3354 "type": "boolean" |
| 3355 }, |
| 3356 "protocol": { |
| 3357 "description": "Protocol used in the instant messenger. It s
hould be one of the values from ImProtocolTypes map. Similar to type, it can tak
e a CUSTOM value and specify the custom name in customProtocol field.", |
| 3358 "type": "string" |
| 3359 }, |
| 3360 "type": { |
| 3361 "description": "Each entry can have a type which indicates s
tandard types of that entry. For example instant messengers could be of home, wo
rk etc. In addition to the standard type, an entry can have a custom type and ca
n take any value. Such types should have the CUSTOM value as type and also have
a customType value.", |
| 3362 "type": "string" |
| 3363 } |
| 3364 }, |
| 3365 "type": "object" |
| 3366 }, |
| 3367 "UserMakeAdmin": { |
| 3368 "description": "JSON request template for setting/revoking admin sta
tus of a user in Directory API.", |
| 3369 "id": "UserMakeAdmin", |
| 3370 "properties": { |
| 3371 "status": { |
| 3372 "annotations": { |
| 3373 "required": [ |
| 3374 "directory.users.makeAdmin" |
| 3375 ] |
| 3376 }, |
| 3377 "description": "Boolean indicating new admin status of the u
ser", |
| 3378 "type": "boolean" |
| 3379 } |
| 3380 }, |
| 3381 "type": "object" |
| 3382 }, |
| 3383 "UserName": { |
| 3384 "description": "JSON template for name of a user in Directory API.", |
| 3385 "id": "UserName", |
| 3386 "properties": { |
| 3387 "familyName": { |
| 3388 "annotations": { |
| 3389 "required": [ |
| 3390 "directory.users.insert" |
| 3391 ] |
| 3392 }, |
| 3393 "description": "Last Name", |
| 3394 "type": "string" |
| 3395 }, |
| 3396 "fullName": { |
| 3397 "description": "Full Name", |
| 3398 "type": "string" |
| 3399 }, |
| 3400 "givenName": { |
| 3401 "annotations": { |
| 3402 "required": [ |
| 3403 "directory.users.insert" |
| 3404 ] |
| 3405 }, |
| 3406 "description": "First Name", |
| 3407 "type": "string" |
| 3408 } |
| 3409 }, |
| 3410 "type": "object" |
| 3411 }, |
| 3412 "UserOrganization": { |
| 3413 "description": "JSON template for an organization entry.", |
| 3414 "id": "UserOrganization", |
| 3415 "properties": { |
| 3416 "costCenter": { |
| 3417 "description": "The cost center of the users department.", |
| 3418 "type": "string" |
| 3419 }, |
| 3420 "customType": { |
| 3421 "description": "Custom type.", |
| 3422 "type": "string" |
| 3423 }, |
| 3424 "department": { |
| 3425 "description": "Department within the organization.", |
| 3426 "type": "string" |
| 3427 }, |
| 3428 "description": { |
| 3429 "description": "Description of the organization.", |
| 3430 "type": "string" |
| 3431 }, |
| 3432 "domain": { |
| 3433 "description": "The domain to which the organization belongs
to.", |
| 3434 "type": "string" |
| 3435 }, |
| 3436 "location": { |
| 3437 "description": "Location of the organization. This need not
be fully qualified address.", |
| 3438 "type": "string" |
| 3439 }, |
| 3440 "name": { |
| 3441 "description": "Name of the organization", |
| 3442 "type": "string" |
| 3443 }, |
| 3444 "primary": { |
| 3445 "description": "If it user's primary organization.", |
| 3446 "type": "boolean" |
| 3447 }, |
| 3448 "symbol": { |
| 3449 "description": "Symbol of the organization.", |
| 3450 "type": "string" |
| 3451 }, |
| 3452 "title": { |
| 3453 "description": "Title (designation) of the user in the organ
ization.", |
| 3454 "type": "string" |
| 3455 }, |
| 3456 "type": { |
| 3457 "description": "Each entry can have a type which indicates s
tandard types of that entry. For example organization could be of school, work e
tc. In addition to the standard type, an entry can have a custom type and can gi
ve it any name. Such types should have the CUSTOM value as type and also have a
CustomType value.", |
| 3458 "type": "string" |
| 3459 } |
| 3460 }, |
| 3461 "type": "object" |
| 3462 }, |
| 3463 "UserPhone": { |
| 3464 "description": "JSON template for a phone entry.", |
| 3465 "id": "UserPhone", |
| 3466 "properties": { |
| 3467 "customType": { |
| 3468 "description": "Custom Type.", |
| 3469 "type": "string" |
| 3470 }, |
| 3471 "primary": { |
| 3472 "description": "If this is user's primary phone or not.", |
| 3473 "type": "boolean" |
| 3474 }, |
| 3475 "type": { |
| 3476 "description": "Each entry can have a type which indicates s
tandard types of that entry. For example phone could be of home_fax, work, mobil
e etc. In addition to the standard type, an entry can have a custom type and can
give it any name. Such types should have the CUSTOM value as type and also have
a customType value.", |
| 3477 "type": "string" |
| 3478 }, |
| 3479 "value": { |
| 3480 "description": "Phone number.", |
| 3481 "type": "string" |
| 3482 } |
| 3483 }, |
| 3484 "type": "object" |
| 3485 }, |
| 3486 "UserPhoto": { |
| 3487 "description": "JSON template for Photo object in Directory API.", |
| 3488 "id": "UserPhoto", |
| 3489 "properties": { |
| 3490 "etag": { |
| 3491 "description": "ETag of the resource.", |
| 3492 "type": "string" |
| 3493 }, |
| 3494 "height": { |
| 3495 "description": "Height in pixels of the photo", |
| 3496 "format": "int32", |
| 3497 "type": "integer" |
| 3498 }, |
| 3499 "id": { |
| 3500 "description": "Unique identifier of User (Read-only)", |
| 3501 "type": "string" |
| 3502 }, |
| 3503 "kind": { |
| 3504 "default": "admin#directory#user#photo", |
| 3505 "description": "Kind of resource this is.", |
| 3506 "type": "string" |
| 3507 }, |
| 3508 "mimeType": { |
| 3509 "description": "Mime Type of the photo", |
| 3510 "type": "string" |
| 3511 }, |
| 3512 "photoData": { |
| 3513 "annotations": { |
| 3514 "required": [ |
| 3515 "directory.users.photos.update" |
| 3516 ] |
| 3517 }, |
| 3518 "description": "Base64 encoded photo data", |
| 3519 "format": "byte", |
| 3520 "type": "string" |
| 3521 }, |
| 3522 "primaryEmail": { |
| 3523 "description": "Primary email of User (Read-only)", |
| 3524 "type": "string" |
| 3525 }, |
| 3526 "width": { |
| 3527 "description": "Width in pixels of the photo", |
| 3528 "format": "int32", |
| 3529 "type": "integer" |
| 3530 } |
| 3531 }, |
| 3532 "type": "object" |
| 3533 }, |
| 3534 "UserRelation": { |
| 3535 "description": "JSON template for a relation entry.", |
| 3536 "id": "UserRelation", |
| 3537 "properties": { |
| 3538 "customType": { |
| 3539 "description": "Custom Type.", |
| 3540 "type": "string" |
| 3541 }, |
| 3542 "type": { |
| 3543 "description": "The relation of the user. Some of the possib
le values are mother, father, sister, brother, manager, assistant, partner.", |
| 3544 "type": "string" |
| 3545 }, |
| 3546 "value": { |
| 3547 "description": "The name of the relation.", |
| 3548 "type": "string" |
| 3549 } |
| 3550 }, |
| 3551 "type": "object" |
| 3552 }, |
| 3553 "UserUndelete": { |
| 3554 "description": "JSON request template to undelete a user in Director
y API.", |
| 3555 "id": "UserUndelete", |
| 3556 "properties": { |
| 3557 "orgUnitPath": { |
| 3558 "description": "OrgUnit of User", |
| 3559 "type": "string" |
| 3560 } |
| 3561 }, |
| 3562 "type": "object" |
| 3563 }, |
| 3564 "Users": { |
| 3565 "description": "JSON response template for List Users operation in A
pps Directory API.", |
| 3566 "id": "Users", |
| 3567 "properties": { |
| 3568 "etag": { |
| 3569 "description": "ETag of the resource.", |
| 3570 "type": "string" |
| 3571 }, |
| 3572 "kind": { |
| 3573 "default": "admin#directory#users", |
| 3574 "description": "Kind of resource this is.", |
| 3575 "type": "string" |
| 3576 }, |
| 3577 "nextPageToken": { |
| 3578 "description": "Token used to access next page of this resul
t.", |
| 3579 "type": "string" |
| 3580 }, |
| 3581 "trigger_event": { |
| 3582 "description": "Event that triggered this response (only use
d in case of Push Response)", |
| 3583 "type": "string" |
| 3584 }, |
| 3585 "users": { |
| 3586 "description": "List of user objects.", |
| 3587 "items": { |
| 3588 "$ref": "User" |
| 3589 }, |
| 3590 "type": "array" |
| 3591 } |
| 3592 }, |
| 3593 "type": "object" |
| 3594 }, |
| 3595 "VerificationCode": { |
| 3596 "description": "JSON template for verification codes in Directory AP
I.", |
| 3597 "id": "VerificationCode", |
| 3598 "properties": { |
| 3599 "etag": { |
| 3600 "description": "ETag of the resource.", |
| 3601 "type": "string" |
| 3602 }, |
| 3603 "kind": { |
| 3604 "default": "admin#directory#verificationCode", |
| 3605 "description": "The type of the resource. This is always adm
in#directory#verificationCode.", |
| 3606 "type": "string" |
| 3607 }, |
| 3608 "userId": { |
| 3609 "description": "The obfuscated unique ID of the user.", |
| 3610 "type": "string" |
| 3611 }, |
| 3612 "verificationCode": { |
| 3613 "description": "A current verification code for the user. In
validated or used verification codes are not returned as part of the result.", |
| 3614 "type": "string" |
| 3615 } |
| 3616 }, |
| 3617 "type": "object" |
| 3618 }, |
| 3619 "VerificationCodes": { |
| 3620 "description": "JSON response template for List verification codes o
peration in Directory API.", |
| 3621 "id": "VerificationCodes", |
| 3622 "properties": { |
| 3623 "etag": { |
| 3624 "description": "ETag of the resource.", |
| 3625 "type": "string" |
| 3626 }, |
| 3627 "items": { |
| 3628 "description": "A list of verification code resources.", |
| 3629 "items": { |
| 3630 "$ref": "VerificationCode" |
| 3631 }, |
| 3632 "type": "array" |
| 3633 }, |
| 3634 "kind": { |
| 3635 "default": "admin#directory#verificationCodesList", |
| 3636 "description": "The type of the resource. This is always adm
in#directory#verificationCodesList.", |
| 3637 "type": "string" |
| 3638 } |
| 3639 }, |
| 3640 "type": "object" |
| 3641 } |
| 3642 }, |
| 3643 "servicePath": "admin/directory/v1/", |
| 3644 "title": "Admin Directory API", |
| 3645 "version": "directory_v1" |
| 3646 } |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 559053002:
Generate 0.1.0 version of googleapis/googleapis_beta (Closed)
Base URL: git@github.com:dart-lang/googleapis.git@master