/usr/share/doc/python-gdata-doc/pydocs/gdata.apps.organization.client.html is in python-gdata-doc 2.0.18+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module gdata.apps.organization.client</title>
<meta charset="utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="gdata.html"><font color="#ffffff">gdata</font></a>.<a href="gdata.apps.html"><font color="#ffffff">apps</font></a>.<a href="gdata.apps.organization.html"><font color="#ffffff">organization</font></a>.client</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/lib/python2.7/dist-packages/gdata/apps/organization/client.py">/usr/lib/python2.7/dist-packages/gdata/apps/organization/client.py</a></font></td></tr></table>
<p><tt><a href="#OrganizationUnitProvisioningClient">OrganizationUnitProvisioningClient</a> simplifies OrgUnit Provisioning API calls.<br>
<br>
<a href="#OrganizationUnitProvisioningClient">OrganizationUnitProvisioningClient</a> extends gdata.client.<a href="gdata.client.html#GDClient">GDClient</a> to ease<br>
interaction with the Google Organization Unit Provisioning API.<br>
These interactions include the ability to create, retrieve, update and delete<br>
organization units, move users within organization units, retrieve customerId<br>
and update and retrieve users in organization units.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gdata.html">gdata</a><br>
</td><td width="25%" valign=top><a href="urllib.html">urllib</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="gdata.client.html#GDClient">gdata.client.GDClient</a>(<a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.apps.organization.client.html#OrganizationUnitProvisioningClient">OrganizationUnitProvisioningClient</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="OrganizationUnitProvisioningClient">class <strong>OrganizationUnitProvisioningClient</strong></a>(<a href="gdata.client.html#GDClient">gdata.client.GDClient</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>Client extension for the Google Org Unit Provisioning API service.<br>
<br>
Attributes:<br>
host: string The hostname for the MultiDomain Provisioning API service.<br>
api_version: string The version of the MultiDomain Provisioning API.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.apps.organization.client.html#OrganizationUnitProvisioningClient">OrganizationUnitProvisioningClient</a></dd>
<dd><a href="gdata.client.html#GDClient">gdata.client.GDClient</a></dd>
<dd><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="OrganizationUnitProvisioningClient-CreateOrgUnit"><strong>CreateOrgUnit</strong></a> = <a href="#OrganizationUnitProvisioningClient-create_org_unit">create_org_unit</a>(self, customer_id, name, parent_org_unit_path<font color="#909090">='/'</font>, description<font color="#909090">=''</font>, block_inheritance<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-DeleteOrgUnit"><strong>DeleteOrgUnit</strong></a> = <a href="#OrganizationUnitProvisioningClient-delete_org_unit">delete_org_unit</a>(self, customer_id, org_unit_path, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-MakeCustomerIdFeedUri"><strong>MakeCustomerIdFeedUri</strong></a> = <a href="#OrganizationUnitProvisioningClient-make_customer_id_feed_uri">make_customer_id_feed_uri</a>(self)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-MakeOrganizationUnitOrgunitProvisioningUri"><strong>MakeOrganizationUnitOrgunitProvisioningUri</strong></a> = <a href="#OrganizationUnitProvisioningClient-make_organization_unit_orgunit_provisioning_uri">make_organization_unit_orgunit_provisioning_uri</a>(self, customer_id, org_unit_path<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-MakeOrganizationUnitOrguserProvisioningUri"><strong>MakeOrganizationUnitOrguserProvisioningUri</strong></a> = <a href="#OrganizationUnitProvisioningClient-make_organization_unit_orguser_provisioning_uri">make_organization_unit_orguser_provisioning_uri</a>(self, customer_id, org_user_email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-MakeOrganizationUnitProvisioningUri"><strong>MakeOrganizationUnitProvisioningUri</strong></a> = <a href="#OrganizationUnitProvisioningClient-make_organization_unit_provisioning_uri">make_organization_unit_provisioning_uri</a>(self, feed_type, customer_id, org_unit_path_or_user_email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-MoveUserToOrgUnit"><strong>MoveUserToOrgUnit</strong></a> = <a href="#OrganizationUnitProvisioningClient-move_users_to_org_unit">move_users_to_org_unit</a>(self, customer_id, org_unit_path, users_to_move, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveAllOrgUnits"><strong>RetrieveAllOrgUnits</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_all_org_units">retrieve_all_org_units</a>(self, customer_id, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveAllOrgUnitsFromUri"><strong>RetrieveAllOrgUnitsFromUri</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_all_org_units_from_uri">retrieve_all_org_units_from_uri</a>(self, uri, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveAllOrgUsers"><strong>RetrieveAllOrgUsers</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_all_org_users">retrieve_all_org_users</a>(self, customer_id, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveAllOrgUsersFromUri"><strong>RetrieveAllOrgUsersFromUri</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_all_org_users_from_uri">retrieve_all_org_users_from_uri</a>(self, uri, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveCustomerId"><strong>RetrieveCustomerId</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_customer_id">retrieve_customer_id</a>(self, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveFeedFromUri"><strong>RetrieveFeedFromUri</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_feed_from_uri">retrieve_feed_from_uri</a>(self, uri, desired_class, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveOrgUnit"><strong>RetrieveOrgUnit</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_org_unit">retrieve_org_unit</a>(self, customer_id, org_unit_path, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveOrgUnitUsers"><strong>RetrieveOrgUnitUsers</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_org_unit_users">retrieve_org_unit_users</a>(self, customer_id, org_unit_path, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveOrgUser"><strong>RetrieveOrgUser</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_org_user">retrieve_org_user</a>(self, customer_id, user_email, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrievePageOfOrgUnits"><strong>RetrievePageOfOrgUnits</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_page_of_org_units">retrieve_page_of_org_units</a>(self, customer_id, startKey<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrievePageOfOrgUsers"><strong>RetrievePageOfOrgUsers</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_page_of_org_users">retrieve_page_of_org_users</a>(self, customer_id, startKey<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RetrieveSubOrgUnits"><strong>RetrieveSubOrgUnits</strong></a> = <a href="#OrganizationUnitProvisioningClient-retrieve_sub_org_units">retrieve_sub_org_units</a>(self, customer_id, org_unit_path, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-UpdateOrgUnit"><strong>UpdateOrgUnit</strong></a> = <a href="#OrganizationUnitProvisioningClient-update_org_unit">update_org_unit</a>(self, customer_id, org_unit_path, org_unit_entry, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-UpdateOrgUser"><strong>UpdateOrgUser</strong></a> = <a href="#OrganizationUnitProvisioningClient-update_org_user">update_org_user</a>(self, customer_id, user_email, org_unit_path, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-__init__"><strong>__init__</strong></a>(self, domain, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Constructs a new client for the Organization Unit Provisioning API.<br>
<br>
Args:<br>
domain: string The Google Apps domain with Organization Unit<br>
Provisioning.<br>
auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br>
OAuthToken which authorizes this client to edit the Organization<br>
Units.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-create_org_unit"><strong>create_org_unit</strong></a>(self, customer_id, name, parent_org_unit_path<font color="#909090">='/'</font>, description<font color="#909090">=''</font>, block_inheritance<font color="#909090">=False</font>, **kwargs)</dt><dd><tt>Create a Organization Unit.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
name: string The simple organization unit text name, not the full path<br>
name.<br>
parent_org_unit_path: string The full path of the parental tree to this<br>
organization unit (default: '/').<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
description: string The human readable text description of the<br>
organization unit (optional).<br>
block_inheritance: boolean This parameter blocks policy setting<br>
inheritance from organization units higher in<br>
the organization tree (default: False).<br>
<br>
Returns:<br>
A gdata.apps.organization.data.OrgUnitEntry representing an organization<br>
unit.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-delete_org_unit"><strong>delete_org_unit</strong></a>(self, customer_id, org_unit_path, **kwargs)</dt><dd><tt>Delete a Orgunit based on its path.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
org_unit_path: string The organization's full path name.<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
<br>
Returns:<br>
An HTTP response object. See gdata.client.<a href="#OrganizationUnitProvisioningClient-request">request</a>().</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-make_customer_id_feed_uri"><strong>make_customer_id_feed_uri</strong></a>(self)</dt><dd><tt>Creates a feed uri for retrieving customerId of the user.<br>
<br>
Returns:<br>
A string giving the URI for retrieving customerId of the user.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-make_organization_unit_orgunit_provisioning_uri"><strong>make_organization_unit_orgunit_provisioning_uri</strong></a>(self, customer_id, org_unit_path<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt><dd><tt>Creates a resource feed URI for the orgunit's Provisioning API calls.<br>
<br>
Using this client's Google Apps domain, create a feed URI for organization<br>
unit orgunit's provisioning in that domain. If an org_unit_path is<br>
provided, return a URI for that specific resource.<br>
If params are provided, append them as GET params.<br>
<br>
Args:<br>
customer_id: string The customerId of the user.<br>
org_unit_path: string (optional) The organization unit's path for which<br>
to make a feed URI.<br>
params: dict (optional) key -> value params to append as GET vars to the<br>
URI. Example: params={'start': 'my-resource-id'}<br>
<br>
Returns:<br>
A string giving the URI for organization unit provisioning for<br>
given org_unit_path</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-make_organization_unit_orguser_provisioning_uri"><strong>make_organization_unit_orguser_provisioning_uri</strong></a>(self, customer_id, org_user_email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt><dd><tt>Creates a resource feed URI for the orguser's Provisioning API calls.<br>
<br>
Using this client's Google Apps domain, create a feed URI for organization<br>
unit orguser's provisioning in that domain. If an org_user_email is<br>
provided, return a URI for that specific resource.<br>
If params are provided, append them as GET params.<br>
<br>
Args:<br>
customer_id: string The customerId of the user.<br>
org_user_email: string (optional) The organization unit's path for which<br>
to make a feed URI.<br>
params: dict (optional) key -> value params to append as GET vars to the<br>
URI. Example: params={'start': 'my-resource-id'}<br>
<br>
Returns:<br>
A string giving the URI for organization user provisioning for<br>
given org_user_email</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-make_organization_unit_provisioning_uri"><strong>make_organization_unit_provisioning_uri</strong></a>(self, feed_type, customer_id, org_unit_path_or_user_email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt><dd><tt>Creates a resource feed URI for the Organization Unit Provisioning API.<br>
<br>
Using this client's Google Apps domain, create a feed URI for organization<br>
unit provisioning in that domain. If an org unit path or org user email<br>
address is provided, return a URI for that specific resource.<br>
If params are provided, append them as GET params.<br>
<br>
Args:<br>
feed_type: string The type of feed (orgunit/orguser)<br>
customer_id: string The customerId of the user.<br>
org_unit_path_or_user_email: string (optional) The org unit path or<br>
org user email address for which to make a feed URI.<br>
params: dict (optional) key -> value params to append as GET vars to the<br>
URI. Example: params={'start': 'my-resource-id'}<br>
<br>
Returns:<br>
A string giving the URI for organization unit provisioning for this<br>
client's Google Apps domain.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-move_users_to_org_unit"><strong>move_users_to_org_unit</strong></a>(self, customer_id, org_unit_path, users_to_move, **kwargs)</dt><dd><tt>Move a user to an Organization Unit.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
org_unit_path: string The organization's full path name.<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
users_to_move: list Email addresses of users to move in list format.<br>
[Note: You can move a maximum of 25 users at one time.]<br>
<br>
Returns:<br>
A gdata.apps.organization.data.OrgUnitEntry representing<br>
an organization unit.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_all_org_units"><strong>retrieve_all_org_units</strong></a>(self, customer_id, **kwargs)</dt><dd><tt>Retrieve all OrgUnits in the customer's domain.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUnitFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_all_org_units_from_uri"><strong>retrieve_all_org_units_from_uri</strong></a>(self, uri, **kwargs)</dt><dd><tt>Retrieve all OrgUnits from given uri.<br>
<br>
Args:<br>
uri: string The uri from where to get the orgunits.<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUnitFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_all_org_users"><strong>retrieve_all_org_users</strong></a>(self, customer_id, **kwargs)</dt><dd><tt>Retrieve all OrgUsers in the customer's domain.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUserFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_all_org_users_from_uri"><strong>retrieve_all_org_users_from_uri</strong></a>(self, uri, **kwargs)</dt><dd><tt>Retrieve all OrgUsers from given uri.<br>
<br>
Args:<br>
uri: string The uri from where to get the orgusers.<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUserFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_customer_id"><strong>retrieve_customer_id</strong></a>(self, **kwargs)</dt><dd><tt>Retrieve the Customer ID for the customer domain.<br>
<br>
Returns:<br>
A gdata.apps.organization.data.CustomerIdEntry.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_feed_from_uri"><strong>retrieve_feed_from_uri</strong></a>(self, uri, desired_class, **kwargs)</dt><dd><tt>Retrieve feed from given uri.<br>
<br>
Args:<br>
uri: string The uri from where to get the feed.<br>
desired_class: Feed The type of feed that if to be retrieved.<br>
<br>
Returns:<br>
Feed of type desired class.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_org_unit"><strong>retrieve_org_unit</strong></a>(self, customer_id, org_unit_path, **kwargs)</dt><dd><tt>Retrieve a Orgunit based on its path.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
org_unit_path: string The organization's full path name.<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
<br>
Returns:<br>
A gdata.apps.organization.data.OrgUnitEntry representing<br>
an organization unit.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_org_unit_users"><strong>retrieve_org_unit_users</strong></a>(self, customer_id, org_unit_path, **kwargs)</dt><dd><tt>Retrieve all OrgUsers of the provided OrgUnit.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
org_unit_path: string The organization's full path name.<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUserFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_org_user"><strong>retrieve_org_user</strong></a>(self, customer_id, user_email, **kwargs)</dt><dd><tt>Retrieve an organization user.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
user_email: string The email address of the user.<br>
<br>
Returns:<br>
A gdata.apps.organization.data.OrgUserEntry representing<br>
an organization user.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_page_of_org_units"><strong>retrieve_page_of_org_units</strong></a>(self, customer_id, startKey<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieve one page of OrgUnits in the customer's domain.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
startKey: string The key to continue for pagination through all OrgUnits.<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUnitFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_page_of_org_users"><strong>retrieve_page_of_org_users</strong></a>(self, customer_id, startKey<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieve one page of OrgUsers in the customer's domain.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
startKey: The string key to continue for pagination through all OrgUnits.<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUserFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-retrieve_sub_org_units"><strong>retrieve_sub_org_units</strong></a>(self, customer_id, org_unit_path, **kwargs)</dt><dd><tt>Retrieve all Sub-OrgUnits of the provided OrgUnit.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
org_unit_path: string The organization's full path name.<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
<br>
Returns:<br>
gdata.apps.organisation.data.OrgUnitFeed object</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-update_org_unit"><strong>update_org_unit</strong></a>(self, customer_id, org_unit_path, org_unit_entry, **kwargs)</dt><dd><tt>Update a Organization Unit.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
org_unit_path: string The organization's full path name.<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
org_unit_entry: gdata.apps.organization.data.OrgUnitEntry<br>
The updated organization unit entry.<br>
<br>
Returns:<br>
A gdata.apps.organization.data.OrgUnitEntry representing an organization<br>
unit.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-update_org_user"><strong>update_org_user</strong></a>(self, customer_id, user_email, org_unit_path, **kwargs)</dt><dd><tt>Update the OrgUnit of a OrgUser.<br>
<br>
Args:<br>
customer_id: string The ID of the Google Apps customer.<br>
user_email: string The email address of the user.<br>
org_unit_path: string The new organization's full path name.<br>
[Note: Each element of the path MUST be URL encoded<br>
(example: finance%2Forganization/suborganization)]<br>
<br>
Returns:<br>
A gdata.apps.organization.data.OrgUserEntry representing<br>
an organization user.</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>api_version</strong> = '2.0'</dl>
<dl><dt><strong>auth_scopes</strong> = ('https://apps-apis.google.com/a/feeds/user/', 'https://apps-apis.google.com/a/feeds/policies/', 'https://apps-apis.google.com/a/feeds/alias/', 'https://apps-apis.google.com/a/feeds/groups/', 'https://apps-apis.google.com/a/feeds/compliance/audit/', 'https://apps-apis.google.com/a/feeds/migration/', 'https://apps-apis.google.com/a/feeds/emailsettings/2.0/')</dl>
<dl><dt><strong>auth_service</strong> = 'apps'</dl>
<dl><dt><strong>host</strong> = 'apps-apis.google.com'</dl>
<dl><dt><strong>ssl</strong> = True</dl>
<hr>
Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><a name="OrganizationUnitProvisioningClient-Batch"><strong>Batch</strong></a> = batch(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-ClientLogin"><strong>ClientLogin</strong></a> = client_login(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
SpreadsheetsClient, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-Delete"><strong>Delete</strong></a> = delete(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-GetAccessToken"><strong>GetAccessToken</strong></a> = get_access_token(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-GetEntry"><strong>GetEntry</strong></a> = get_entry(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-GetFeed"><strong>GetFeed</strong></a> = get_feed(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-GetNext"><strong>GetNext</strong></a> = get_next(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-GetOAuthToken"><strong>GetOAuthToken</strong></a> = get_oauth_token(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-Post"><strong>Post</strong></a> = post(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-Request"><strong>Request</strong></a> = request(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = request_client_login_token(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-RevokeToken"><strong>RevokeToken</strong></a> = revoke_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-Update"><strong>Update</strong></a> = update(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-UpgradeToken"><strong>UpgradeToken</strong></a> = upgrade_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-batch"><strong>batch</strong></a>(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
SpreadsheetsClient, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-delete"><strong>delete</strong></a>(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-get_access_token"><strong>get_access_token</strong></a>(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-get_entry"><strong>get_entry</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-get_feed"><strong>get_feed</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-get_next"><strong>get_next</strong></a>(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-get_oauth_token"><strong>get_oauth_token</strong></a>(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-post"><strong>post</strong></a>(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-request"><strong>request</strong></a>(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-revoke_token"><strong>revoke_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-update"><strong>update</strong></a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><strong>alt_auth_service</strong> = None</dl>
<hr>
Methods inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><a name="OrganizationUnitProvisioningClient-Get"><strong>Get</strong></a> = get(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-Put"><strong>Put</strong></a> = put(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-get"><strong>get</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="OrganizationUnitProvisioningClient-put"><strong>put</strong></a>(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>auth_token</strong> = None</dl>
<dl><dt><strong>xoauth_requestor_id</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>CUSTOMER_ID_URI_TEMPLATE</strong> = '/a/feeds/customer/%s/customerId'<br>
<strong>ORGANIZATION_UNIT_FEED</strong> = 'orgunit'<br>
<strong>ORGANIZATION_UNIT_URI_TEMPLATE</strong> = '/a/feeds/%s/%s/%s'<br>
<strong>ORGANIZATION_USER_FEED</strong> = 'orguser'<br>
<strong>__author__</strong> = 'Gunjan Sharma <gunjansharma@google.com>'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">Gunjan Sharma <gunjansharma@google.com></td></tr></table>
</body></html>
|