Protocol

POST https://apps-apis.google.com/a/feeds/domain/user/2.0

<?xml version="1.0" encoding="UTF-8"?>
<atom:entry
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:apps="http://schemas.google.com/apps/2006">
<atom:category
scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/apps/2006#user"/>
<apps:login
userName="SusanJones-1321"
password="51eea05d46317fadd5cad6787a8f562be90b4446"
hashFunctionName="SHA-1" suspended="false"/>
<apps:quota limit="2048"/>
<apps:name familyName="Jones"
givenName="Susan"/>
</atom:entry>

• In a request to create a user, the <apps:name> tag and its attributes – `familyName` and `givenName` – are required. However, a request to update a user does not need to include this tag or its attributes unless the request is updating the user's given name or family name.
• In a request to create a user, the <apps:login> tag is required, and the request must provide values for the `username` and `password` attributes. The `username` has to be unique and cannot be a nickname of another user. A request to update a user does not need to include the <apps:login> tag. In addition, the request should not provide a value for the <apps:login> tag's `password` attribute unless the user's password is being updated. As a recommended option, send the `password` value as a base 16-encoded hash value. Set the `hashFunctionName` attribute to either the SHA-1 or MD5 hash format.
• Typically, the `suspended` attribute of the <apps:login> tag only appears in update requests. (By default, newly created accounts are active.)

• The `userName` argument contains the unique name that identifies the account owner and cannot be a nickname of another user.
• The `givenName` argument contains the user's first name.
• The `familyName` argument contains the user's last name.
• The `password` argument contains the password for the user account.
• The `hashFunctionName` argument specifies the hash format of the password parameter.
• The `limit` argument identifies the amount of disk space in MB that will be allocated to the user account.

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.createUser(String username, String givenName, String familyName, String password)
client.createUser(String username, String givenName, String familyName, String password, Integer quotaLimitInMb)
client.createUser(String username, String givenName, String familyName, String password, String passwordHashFunction)
client.createUser(String username, String givenName, String familyName, String password, String passwordHashFunction, Integer quotaLimitInMb)

• The `username` argument contains the unique name that identifies the account owner and cannot be a nickname of another user.
• The `givenName` argument contains the user's first name.
• The `familyName` argument contains the user's last name.
• The `password` argument contains the password for the user account.
• The `passwordHashFunction` argument specifies the hash format of the password parameter.
• The `quotaLimitInMb` argument identifies the amount of disk space in MB that will be allocated to the user account.

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.CreateUser(user_name, family_name, given_name, password, suspended=False, admin=None, quota_limit=None, password_hash_function=None, change_password=None)

• The `user_name` argument contains the unique name that identifies the account owner and cannot be a nickname of another user.
• The `family_name` argument contains the user's last name.
• The `given_name` argument contains the user's first name.
• The `password` argument contains the password for the user account.
• The `suspended` argument specified whether the user account should be suspended.
• The `admin` argument specified whether the user account should have administrator privileges.
• The `quota_limit` argument identifies the amount of disk space in MB that will be allocated to the user account.
• The `password_hash_function` argument specifies the hash format of the password parameter.
• The `change_password` argument specifies whether the user is forced to change password at the next login.

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.CreateUser(String username, String givenName, String familyName, String password)
service.CreateUser(String username, String givenName, String familyName, String password, int quotaLimitInMb)
service.CreateUser(String username, String givenName, String familyName, String password, String passwordHashFunction)
service.CreateUser(String username, String givenName, String familyName, String password, String passwordHashFunction, int quotaLimitInMb)

• The `username` argument contains the unique name that identifies the account owner and cannot be a nickname of another user.
• The `givenName` argument contains the user's first name.
• The `familyName` argument contains the user's last name.
• The `password` argument contains the password for the user account.
• The `passwordHashFunction` argument specifies the hash format of the password parameter.
• The `quotaLimitInMb` argument identifies the amount of disk space in MB that will be allocated to the user account.

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->createUser($username, $givenName, $familyName, $password, $passwordHashFunction=null, $quota=null)

• The `username` argument contains the unique name that identifies the account owner and cannot be a nickname of another user.
• The `givenName` argument contains the user's first name.
• The `familyName` argument contains the user's last name.
• The `password` argument contains the password for the user account.
• The `passwordHashFunction` argument specifies the hash format of the password parameter.
• The `quota` argument identifies the amount of disk space in MB that will be allocated to the user account.

Protocol

To retrieve a specific user account, use the following `GET` request:

GET https://apps-apis.google.com/a/feeds/domain/user/2.0/userName

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrieveUser(String username)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.RetrieveUser(user_name)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RetrieveUser(String username)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveUser($username)

Protocol

GET https://apps-apis.google.com/a/feeds/domain/user/2.0

Sample UserFeed Response

<?xml version="1.0" encoding="UTF-8"?>
<atom:feed
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:apps="http://schemas.google.com/apps/2006"
xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"
xmlns:gd="http://schemas.google.com/g/2005">
<atom:id>
https://apps-apis.google.com/a/feeds/example.com/user/2.0
</atom:id>
<atom:updated>1970-01-01T00:00:00.000Z&
lt;/atom:updated>
<atom:category
scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/apps/2006#user"/>
<atom:title
type="text">Users</atom:title>
<atom:link rel="next"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0?startUsername=
john"/>
<atom:link
rel="http://schemas.google.com/g/2005#feed"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0"/>
<atom:link
rel="http://schemas.google.com/g/2005#post"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0"/>
<atom:link rel="self"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0"/>
<openSearch:startIndex>1</
openSearch:startIndex>
<atom:entry>
<atom:id>
https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones
</atom:id>
<atom:category
scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/apps/2006#user"/>
<atom:title
type="text">SusanJones</atom:title>
<atom:link rel="self"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones"/>
<atom:link rel="edit"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones"/>
<gd:who
rel="http://schemas.google.com/apps/2006#user.recipient"
email="SusanJones@example.com"/>
<apps:login userName="SusanJones"
suspended="false" admin="false" changePasswordAtNextLogin="false"
agreedToTerms="true"/>
<apps:quota limit="2048"/>
<apps:name familyName="Jones"
givenName="Susan"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.nicknames"
href="https://apps-apis.google.com/a/feeds/example.com/nickname/2.0?username=
SusanJones"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.emailLists"
href="https://apps-apis.google.com/a/feeds/group/2.0/example.com/?recipient=
SusanJones@example.com"/>
</atom:entry>
<atom:entry>
<atom:id>
https://apps-apis.google.com/a/feeds/example.com/user/2.0/JohnSmith
</atom:id>
<atom:category
scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/apps/2006#user"/>
<atom:title
type="text">JohnSmith</atom:title>
<atom:link rel="self"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/JohnSmith"/>
<atom:link rel="edit"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/JohnSmith"/>
<gd:who
rel="http://schemas.google.com/apps/2006#user.recipient"
email="JohnSmith@example.com"/>
<apps:login userName="JohnSmith"
suspended="false" admin="false" changePasswordAtNextLogin="false"
agreedToTerms="true"/>
<apps:quota limit="2048"/>
<apps:name familyName="Smith"
givenName="John"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.nicknames"
href="https://apps-apis.google.com/a/feeds/example.com/nickname/2.0?username=
JohnSmith"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.group"
href="https://apps-apis.google.com/a/feeds/group/example.com/2.0?recipient=
JohnSmith@example.com"/>
</atom:entry>
</atom:feed>

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrieveAllUsers()

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.RetrieveAllUsers()

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RetrieveAllUsers()

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveAllUsers()

Protocol

GET https://apps-apis.google.com/a/feeds/domain/user/2.0

Sample UserFeed Response

<?xml version="1.0" encoding="UTF-8"?>
<atom:feed
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:apps="http://schemas.google.com/apps/2006"
xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"
xmlns:gd="http://schemas.google.com/g/2005">
<atom:id>
https://apps-apis.google.com/a/feeds/example.com/user/2.0
</atom:id>
<atom:updated>1970-01-01T00:00:00.000Z&
lt;/atom:updated>
<atom:category
scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/apps/2006#user"/>
<atom:title
type="text">Users</atom:title>
<atom:link rel="next"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0?startUsername=
john"/>
<atom:link
rel="http://schemas.google.com/g/2005#feed"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0"/>
<atom:link
rel="http://schemas.google.com/g/2005#post"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0"/>
<atom:link rel="self"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0"/>
<openSearch:startIndex>1</
openSearch:startIndex>
<atom:entry>
<atom:id>
https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones
</atom:id>
<atom:category
scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/apps/2006#user"/>
<atom:title
type="text">SusanJones</atom:title>
<atom:link rel="self"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones"/>
<atom:link rel="edit"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones"/>
<gd:who
rel="http://schemas.google.com/apps/2006#user.recipient"
email="SusanJones@example.com"/>
<apps:login userName="SusanJones"
suspended="false" admin="false" changePasswordAtNextLogin="false"
agreedToTerms="true"/>
<apps:quota limit="2048"/>
<apps:name familyName="Jones"
givenName="Susan"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.nicknames"
href="https://apps-apis.google.com/a/feeds/example.com/nickname/2.0?username=
SusanJones"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.emailLists"
href="https://apps-apis.google.com/a/feeds/group/2.0/example.com/?recipient=
SusanJones@example.com"/>
</atom:entry>
<atom:entry>
 ...
</atom:entry>
 ...
</atom:feed>

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrievePageOfUsers(String startUsername)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.RetrievePageOfUsers(start_username=None)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RetrievePageOfUsers(String startUsername)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrievePageOfUsers($startUsername=null)

Protocol

PUT https://apps-apis.google.com/a/feeds/domain/user/2.0/userName

PUT https://apps-apis.google.com/a/feeds/domain/user/2.0/userName

Sample User Entry Request

<?xml version="1.0" encoding="UTF-8"?>
<atom:entry
xmlns:atom="http://www.w3.org/2005/Atom"
 xmlns:apps="http://schemas.google.com/apps/2006">
 <atom:category
scheme="http://schemas.google.com/g/2005#kind"
 term="http://schemas.google.com/apps/2006#user"/>
 <apps:login
userName="NewUserName"
password="51eea05d46317fadd5cad6787a8f562be90b4446" hashFunctionName="SHA-1"
suspended="false"/>
</atom:entry>

Sample User Entry Response

<?xml version="1.0" encoding="UTF-8"?>
<atom:entry
xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:apps="http://schemas.google.com/apps/2006"
xmlns:gd="http://schemas.google.com/g/2005">
<atom:id>https://apps-apis.google.com/a/
feeds/example.com/user/2.0/SusanJones</atom:id>
<atom:updated>1970-01-01T00:00:00.000Z&
lt;/atom:updated>
<atom:category
scheme="http://schemas.google.com/g/2005#kind"
term="http://schemas.google.com/apps/2006#user"/>
<atom:title
type="text">SusanJones</atom:title>
<atom:link rel="self"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones"/>
<atom:link rel="edit"
type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/example.com/user/2.0/SusanJones"/>
<apps:login userName="SusanJones"
suspended="false" admin="false" changePasswordAtNextLogin="false"
agreedToTerms="true"/>
<apps:name familyName="Jones"
givenName="Susan"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.nicknames"
href="https://apps-apis.google.com/a/feeds/example.com/nickname/2.0?username=
Susy-1321"/>
<gd:feedLink
rel="http://schemas.google.com/apps/2006#user.groups"
href="https://apps-apis.google.com/a/feeds//group/2.0/?recipient=us-
sales@example.com"/>
</atom:entry>

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.updateUser(String username, UserEntry userEntry)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.UpdateUser(user_name, user_entry)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.UpdateUser(UserEntry userEntry)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->updateUser($username, $userEntry)

Protocol

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.suspendUser(String username)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
user_entry = client.RetrieveUser(user_name)
user_entry.login.suspended = True
client.UpdateUser(user_name, user_entry)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.SuspendUser(String username)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->suspendUser($username)

Protocol

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.restoreUser(String username)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
user_entry = client.RetrieveUser(user_name)
user_entry.login.suspended = False
client.UpdateUser(user_name, user_entry)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RestoreUser(String username)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->restoreUser($username)

Protocol

DELETE
https://apps-apis.google.com/a/feeds/domain/user/2.0/userName

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.deleteUser(String username)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.DeleteUser(user_name)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.DeleteUser(String username)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->deleteUser($username)

Protocol

POST https://apps-apis.google.com/a/feeds/domain/nickname/2.0

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.createNickname(String username, String nickname)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.CreateNickname(user_name, nickname)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.CreateNickname(String username, String nickname)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->createNickname($username, $nickname)

Protocol

GET https://apps-apis.google.com/a/feeds/domain/nickname/2.0/nickname

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrieveNickname(String nickname)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.RetrieveNickname(nickname)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RetrieveNickname(String nickname)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveNickname($nickname)

Protocol

GET https://apps-apis.google.com/a/feeds/domain/nickname/2.0?username=
userName

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrieveNicknames(String username)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.RetrieveNicknames(user_name)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RetrieveNicknames(String username)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveNicknames($username)

Protocol

GET https://apps-apis.google.com/a/feeds/domain/nickname/2.0

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrieveAllNicknames()

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RetrieveAllNicknames()

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
client.retrieveAllNicknames()

Protocol

GET https://apps-apis.google.com/a/feeds/domain/nickname/2.0

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrievePageOfNicknames(String startNickname)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, email, password);
service.RetrievePageOfNicknames(String startNickname)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrievePageOfNicknames($startNickname=null)

Protocol

DELETE https://apps-apis.google.com/a/feeds/domain/nickname/2.0/nickname

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.deleteNickname(String nickname)

Python

import gdata.apps.client
...
client = gdata.apps.client.AppsClient(domain=domain)
client.ClientLogin(email=email, password=password, source='apps')
client.DeleteNickname(nickname)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.DeleteNickname(String nickname);

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->deleteNickname($nickname)

Protocol

POST https://apps-apis.google.com/a/feeds/group/2.0/domain

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.createGroup(String groupId, String groupName, String groupDescription, String emailPermission)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.CreateGroup(group_id, group_name, description, email_permission)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.createGroup(String groupId, String groupName, String description, PermissionLevel? emailPermission)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->createEmailList($listName)

Protocol

GET https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.retrieveGroup(String groupId)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.RetrieveGroup(group_id)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.RetrieveGroup(String groupId)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveGroup($listName)

Protocol

PUT https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.updateGroup(String groupId, String groupName, String description, String emailPermission)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.UpdateGroup(group_id, group_entry)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.UpdateGroup(String groupId, String groupName, String description, String emailPermission)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
client.Groups.UpdateGroup(String groupId, String groupName, String description, String emailPermission)

Protocol

GET https://apps-apis.google.com/a/feeds/group/2.0/domain/?member=memberId[&directOnly=true|false]

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.retrieveGroups(String memberId, Boolean directOnly)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.RetrieveGroups(member_id, direct_only=False)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.RetrieveGroups(String memberId, Boolean directOnly)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveGroup($memberId)

Protocol

GET https://apps-apis.google.com/a/feeds/group/2.0/domain[?[start=]]

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.retrieveAllGroups()

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.RetrieveAllGroups()

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.RetrieveAllGroups()

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveAllGroups()

Protocol

DELETE https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.deleteGroup(String groupId)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.DeleteGroup(group_id)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.DeleteGroup(String groupId)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->deleteGroup($groupName)

Protocol

POST https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/member

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.addMemberToGroup(String groupId, String memberId)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.AddMemberToGroup(group_id, member_id)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.AddMemberToGroup(String memberId, String groupId)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->addRecipientToEmailList($memberId, $groupId)

Protocol

GET https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/member[?[start=]&[includeSuspendedUsers=true|false]]

• `start` - the start key for resuming a paged feed.
• `includeSuspendedUsers` - true, to include suspended users. The default value is false.

GET https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/member/memberId

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.retrieveAllMembers(String groupId)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.RetrieveAllMembers(group_id)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.RetrieveAllMembers(String groupId)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->retrieveAllMembers($listName)

Protocol

DELETE https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/member/memberId

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.deleteMemberFromGroup(String groupId, String memberName)

Python

import gdata.apps.groups.client
...
groupClient = gdata.apps.groups.client.GroupsProvisioningClient(domain=domain)
groupClient.ClientLogin(email=email, password=password, source='apps')
groupClient.RemoveMemberFromGroup(group_id, member_id)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.RemoveMemberFromGroup(String memberId, String groupId)

PHP

<?php
require_once 'Zend/Loader.php';
Zend_Loader::loadClass('Zend_Gdata_ClientLogin');
Zend_Loader::loadClass('Zend_Gdata_Gapps');
...
$client = Zend_Gdata_ClientLogin::getHttpClient($email, $password, Zend_Gdata_Gapps::AUTH_SERVICE_NAME);
$client->removeRecipientFromGroup($recipient, $listName)

Protocol

POST https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/owner

Sample OwnerEntry Request

<?xml version="1.0" encoding="UTF-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:apps="http://schemas.google.com/apps/2006"
xmlns:gd="http://schemas.google.com/g/2005">
<apps:property name="email" value="joe@example.com"/>
</atom:entry>

<?xml version="1.0" encoding="UTF-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom"
xmlns:apps="http://schemas.google.com/apps/2006"
xmlns:gd="http://schemas.google.com/g/2005">
<apps:property name="email" value="sales-leads@example.com"/>
</atom:entry>

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.addOwnerToGroup(String groupId, String ownerName)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.AddOwnerToGroup(String email, String groupId)

Protocol

GET https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/owner[?[start=]]

• `start` — The start key for resuming a paged feed. This parameter is optional.
• If the response returns over 200 entries, the responses includes pagination link tags.

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
client.retrieveGroupOwners(String groupId)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.RetrieveGroupOwners(String groupId)

Protocol

GET https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/owner/ownerEmail

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.isOwner(String groupId, String email)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.IsOwner(String email, String groupId)

Protocol

DELETE https://apps-apis.google.com/a/feeds/group/2.0/domain/groupId/owner/ownerEmail

Java

import sample.appsforyourdomain.AppsForYourDomainClient;
...
AppsForYourDomainClient client = new AppsForYourDomainClient(email, password, domain);
groupsService.removeOwnerFromGroup(String email, String groupId)

.NET

using Google.GData.Apps;
...
AppsService service = new AppsService(domain, userName, password);
service.Groups.RemoveOwnerFromGroup(String email, String groupId)

Protocol

POST https://apps-apis.google.com/a/feeds/user/2.0/the domain name

POST https://apps-apis.google.com/a/feeds/user/2.0/example.com

Content-type: application/atom+xml

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name="password" value="your domain password in SHA-1 hash format"/>
<apps:property name="hashFunction" value="SHA-1"/>
<apps:property name="userEmail" value="liz@example.com"/>
<apps:property name="firstName" value="Liz"/>
<apps:property name="lastName" value="Smith"/>
<apps:property name="isAdmin" value="true"/>
</atom:entry>

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz@example.com</id>
<updated>2008-10-17T15:02:45.646Z</updated>
<link rel='self' type='application/atom+xml'
href='https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40@example.com'/>
<link rel='edit' type='application/atom+xml'
href='https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40@example.com'/>
    <apps:property name='password'
value='51eea05d46317fadd5cad6787a8f562be90b4446'/>
    <apps:property name='userEmail' value='liz@example.com'/>
    <apps:property name='firstName' value='Liz'/>
    <apps:property name='lastName' value='Smith'/>
    <apps:property name='isAdmin' value='true'/>
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail,
adminPassword, domain, appName);
multiDomainClient.createUser(String email, String password, String firstName, String lastName,
Map<UserProperty, String>optionalAttributes)

• The `email` argument contains the email address of the user.
• The `firstName` argument contains the user's first name.
• The `lastName` argument contains the user's last name.
• The `password` argument contains the password for the user account.
• The `optionalAttributes` argument (optional) contains a hashmap of user properties and values. The keys available are:

  -HASH_FUNCTION: The name of the hash function.

  -ADMIN: Whether the user is an admin or not.

  -SUSPENDED: Is the new user suspended.

  -CHANGE_PASSWORD_AT_NEXT_LOGIN: Should a user be prompted for a password change at next login.

  -QUOTA: Quota allocated to the user in Gb.

  -IP_WHITELIST: Determines whether or not the user's ip is whitelisted.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.CreateUser(email, first_name, last_name, password, is_admin, hash_function=None, suspended=None, change_password=None, ip_whitelisted=None, quota=None)

• The `email` argument contains the email address of the user.
• The `first_name` argument contains the user's first name.
• The `last_name` argument contains the user's last name.
• The `password` argument contains the password for the user account.
• The `is_admin` argument determines whether or not the user had admin privileges.
• The `hash_function` argument (optional) contains the name of the function used to hash the password.
• The `suspended` argument (optional) determines whether or not the user account is suspended.
• The `change_password` argument (optional) determineswhether or not the user must change password at first login.
• The `ip_whitelisted` argument (optional) determines whether or not the user's ip is whitelisted.
• The `quota` argument (optional) is the value (in GB) of the user's quota.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.CreateDomainUser(String domain, String userEmail, String password, String firstName, String lastName, Boolean isAdmin)
service.CreateDomainUser(String domain, String userEmail, String password, String hashFunction, String firstName, String lastName, Boolean isAdmin)

• The `domain` argument dentifies the domain on which you are creating the user.
• The `userEmail` argument contains the unique email address that identifies the account.
• The `password` argument contains the password for the user account.
• The `hashFunction` argument contains the name of the function used to hash the password.
• The `firstName` argument contains the user's first name.
• The `lastName` argument contains the user's last name.
• The `isAdmin` argument determines whether or not the user had admin privileges.

Protocol

PUT https://apps-apis.google.com/a/feeds/user/2.0/the domain name/user email address

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='firstName' value='Elizabeth'/>
</atom:entry>

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40example.com</id>
    <updated>2008-10-17T15:02:45.646Z</atom:updated>
    <link rel='self' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40example.com'/>
    <link rel='edit' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40example.com'/>
    <apps:property name="userEmail" value="liz@example.com" />
    <apps:property name="isAdmin" value="true" />
    <apps:property name="firstName" value="Elizabeth" />
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);

multiDomainClient.updateUser(String email, Map<String, String> updatedAttributes)

• The `email` argument identifies the email account that you are updating.
• The `updateAttributes` argument is a key-value map of attributes to be updated on a user account, including the user's first name, last name and password. The available keys are:

-password: The password of the user.

-firstName: First name of the user.

-lastName: Last name of the user.

-name: The name of the hash function.

-isAdmin: Whether the user is an admin or not.

-isSuspended: Is the new user suspended.

-isChangePasswordAtNextLogin: Should a user be prompted for a password change at next login.

-quotaInGb: Quota allocated to the user in Gb.

-ipWhitelisted: Determines whether or not the user's ip is whitelisted.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.UpdateUser(email, user_entry)

• The `email` argument identifies the email account that you are updating.
• The `user_entry` object contains updated values about a user account, including the user's first name, last name, username and password.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.UpdateDomainUser(String domain, String userEmail, IDictionary attributes)

• The `domain` argument identifies the user's domain.
• The `userEmail` argument contains the unique email address that identifies the account.
• The `attributes` argument contains the set of attributes to update.

Protocol

PUT https://apps-apis.google.com/a/feeds/user/userEmail/2.0/the old domain name/full old primary email address

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='newEmail' value='liz@newexample4liz.com'/>
</atom:entry>

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/user/userEmail/2.0/example.com/
liz%40example.com</id>
    <updated>2008-10-17T15:02:45.646Z</atom:updated>
    <link rel='self' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/user/userEmail/2.0/example.com/liz%40example.com'/>
    <link rel='edit' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/user/userEmail/2.0/example.com/liz%40example.com'/>
    <apps:property name="newEmail" value="liz@newexample4liz.com"
/>
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail,
adminPassword, domain, appName);
multiDomainClient.updateEmailAddress(String oldEmailAddress, String newEmailAddress)

• The `oldEmailAddress` argument identifies the email address that you are renaming.
• The `newEmailAddress` argument identifies the new email address.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.RenameUser(old_email, new_email)

• The `old_email` argument identifies the email account to be renamed.
• The `new_email` argument identifies the new email account.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RenameDomainUser(String domain, String userEmail, String newEmail)

• The `domain` argument identifies the user's domain.
• The `userEmail` argument contains the unique email address that identifies the account.
• The `newEmail` argument contains the new user's email address.

Protocol

GET https://apps-apis.google.com/a/feeds/user/2.0/the domain name/full user email

GET https://apps-apis.google.com/a/feeds/user/2.0/another_example.com/joe@another_example.com

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/user/2.0/another_example.com/joe%
40another%5Fexample.com</id>
<updated>2008-10-17T15:02:45.646Z</atom:updated>
<link rel='self' type='application/atom+xml'
href='https://apps-apis.google.com/a/feeds/user/2.0/another_example.com/joe%40another%5Fexample.com'/>
    <link rel='edit' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/user/2.0/another_example.com/joe%40another%5Fexample.com'/>
    <apps:property name="lastName" value="Jones" />
    <apps:property name="isChangePasswordAtNextLogin" value="false"
/>
    <apps:property name="isSuspended" value="false" />
    <apps:property name="userEmail" value="joe@another_example.com"
/>
    <apps:property name="isAdmin" value="false" />
    <apps:property name="firstName" value="joe" />
    <apps:property name="ipWhitelisted" value="false" />
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.retrieveUser(String email)

• The `email` argument identifies the email address of the user to be retrieved.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.RetrieveUser(email)

• The `email` argument identifies the email account of the user to be retrieved.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveDomainUser(String domain, String userEmail)

• The `domain` argument identifies the user's domain.
• The `userEmail` argument contains the unique email address that identifies the account.

Protocol

GET https://apps-apis.google.com/a/feeds/user/2.0/the domainname?start=the user name@domain.com

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:openSearch="http://a9.com/-/spec/opensesearchrss/1.0/"
mlns:apps="http://schemas.google.com/apps/2006">
 
<id>https://apps-apis.google.com/a/feeds/user/2.0/example.com</id>
  <updated>2010-01-26T23:38:13.215Z</updated>
  <link rel="http://schemas.google.com/g/2005#feed"
  type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/user/2.0/example.com" />
  <link rel="http://schemas.google.com/g/2005#post"
  type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/user/2.0/example.com" />
  <link rel="self" type="application/atom+xml"
 
href="https://apps-apis.google.com/a/feeds/user/2.0/example.com?start=admin%40example.com" />
  <openSearch:startIndex>1</openSearch:startIndex>
  <entry>
   
<id>https://apps-apis.google.com/a/feeds/user/2.0/example.com/admin%40example.com</id>
    <updated>2010-01-26T23:38:13.210Z</updated>
    <link rel="self" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/user/2.0/example.com/admin%40example.com" />
    <link rel="edit" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/user/2.0/example.com/admin%40example.com" />
    <apps:property name="lastName" value="Brown" />
    <apps:property name="isChangePasswordAtNextLogin" value="false"
/>
    <apps:property name="isSuspended" value="false" />
    <apps:property name="userEmail" value="admin@example.com" />
    <apps:property name="isAdmin" value="true" />
    <apps:property name="firstName" value="Joe" />
    <apps:property name="ipWhitelisted" value="false" />
  </entry>
  <entry>
   
<id>https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40example.com</id>
    <updated>2010-01-26T23:38:13.210Z</updated>
    <link rel="self" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40example.com" />
    <link rel="edit" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/user/2.0/example.com/liz%40example.com" />
    <apps:property name="lastName" value="Smith" />
    <apps:property name="isChangePasswordAtNextLogin" value="false"
/>
    <apps:property name="isSuspended" value="false" />
    <apps:property name="userEmail" value="liz@example.com" />
    <apps:property name="isAdmin" value="true" />
    <apps:property name="firstName" value="Elizabeth" />
    <apps:property name="ipWhitelisted" value="false" />
  </entry>
</feed>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.retrieveAllUsers()

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.RetrieveAllUsers()

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveAllDomainUsers(String domain)

Protocol

DELETE https://apps-apis.google.com/a/feeds/user/2.0/the domain name/user email address

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.deleteUser(email)

• The `email` argument identifies the email address of the user to be deleted.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.DeleteUser(email)

• The `email` argument identifies the email account of the user to be deleted.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.DeleteDomainUser(String domain, String userEmail)

• The `domain` argument identifies the user's domain.
• The `userEmail` argument contains the unique email address that identifies the account.

Protocol

POST https://apps-apis.google.com/a/feeds/alias/2.0/the alias domain

Content-type: application/atom+xml

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
    <apps:property name="aliasEmail"
value="helpdesk@gethelp_example.com" />
    <apps:property name="userEmail" value="liz@example.com" />
  </atom:entry>

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%5Fexample.com</id>
<updated>2008-10-17T15:02:45.646Z</atom:updated>
<link rel='self' type='application/atom+xml'
href='https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%5Fexample.com'/>
    <link rel='edit' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%5Fexample.com'/>
    <apps:property name="userEmail" value="liz@example.com" />
    <apps:property name="aliasEmail"
value="helpdesk@gethelp_example.com" />
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.createAlias(String aliasEmail, String userEmail)

• The `aliasEmail` argument identifies the alias email of the user.
• The `userEmail` argument is the email address of the user.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.CreateAlias(user_email, alias_email)

• The `user_email` argument identifies the email of the user.
• The `alias_email` argument is the alias email of the user.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.CreateDomainUserAlias(String domain, String userEmail, String aliasEmail)

• The `domain` argument identifies the user's domain.
• The `userEmail` argument contains the unique email address that identifies the account.
• The `aliasEmail` argument contains the alias to be added to the user.

Protocol

GET https://apps-apis.google.com/a/feeds/alias/2.0/the domain name/alias email address

GET https://apps-apis.google.com/a/feeds/alias/2.0/example.com/helpdesk@example.com

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%5Fexample.com</id>
<updated>2008-10-17T15:02:45.646Z</atom:updated>
<link rel='self' type='application/atom+xml'
href='https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%5Fexample.com'/>
    <link rel='edit' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%5Fexample.com'/>
    <apps:property name="userEmail" value="liz@example.com" />
    <apps:property name="aliasEmail"
value="helpdesk@gethelp_example.com" />
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.retrieveAlias(String aliasEmail)

• The `aliasEmail` argument is email alias of the user.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.RetrieveAlias(email)

• The `email` argument identifies the email of the alias to be retrieved.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveDomainUserAlias(String domain, String aliasEmail)

• The `domain` argument identifies the user alias's domain or the domain in the user's primary email address.
• The `aliasEmail` argument contains the alias' email address.

Protocol

GET https://apps-apis.google.com/a/feeds/alias/2.0/the domain name?start=alias@domain

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"
xmlns:apps="http://schemas.google.com/apps/2006">
 
<id>https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com<
/id>
  <updated>2010-01-26T23:38:13.215Z</updated>
  <link rel="http://schemas.google.com/g/2005#feed"
  type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com" />
  <link rel="http://schemas.google.com/g/2005#post"
  type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com" />
  <link rel="self" type="application/atom+xml"
 
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com?start=
helpdesk%40gethelp%2Fexample.com" />
  <openSearch:startIndex>1</openSearch:startIndex>
  <entry>
   
<id>https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%2Fexample.com</id>
    <updated>2010-01-26T23:38:13.210Z</updated>
    <link rel="self" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%2Fexample.com" />
    <link rel="edit" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%2Fexample.com" />
    <apps:property name="userEmail" value="liz@example.com" />
    <apps:property name="aliasEmail"
value="helpdesk@gethelp_example.com" />
  </entry>
<entry>
 ...
</entry>
 ...
</feed>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.retrieveAllAliases()

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.RetrieveAllAliases()

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveAllDomainUserAlias(String domain)

Protocol

GET https://apps-apis.google.com/a/feeds/alias/2.0/the domain name?userEmail=user@domain

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"
xmlns:apps="http://schemas.google.com/apps/2006">
 
<id>https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com<
/id>
  <updated>2010-01-26T23:38:13.215Z</updated>
  <link rel="http://schemas.google.com/g/2005#feed"
  type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com" />
  <link rel="http://schemas.google.com/g/2005#post"
  type="application/atom+xml"
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com" />
  <link rel="self" type="application/atom+xml"
 
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com?
userEmail=helpdesk%40gethelp%2Fexample.com" />
  <openSearch:startIndex>1</openSearch:startIndex>
  <entry>
   
<id>https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%2Fexample.com</id>
    <updated>2010-01-26T23:38:13.210Z</updated>
    <link rel="self" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%2Fexample.com" />
    <link rel="edit" type="application/atom+xml"
   
href="https://apps-apis.google.com/a/feeds/alias/2.0/gethelp_example.com/
helpdesk%40gethelp%2Fexample.com" />
    <apps:property name="userEmail" value="liz@example.com" />
    <apps:property name="aliasEmail"
value="helpdesk@gethelp_example.com" />
  </entry>
</feed>

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.retrieveAllUserAliases(String userEmail)

• The `userEmail` argument is the email address of the user.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.RetrieveAllUserAliases(user_email)

• The `user_email` argument identifies the email of the user.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveAllDomainUserAliasForUser(String domain, String userEmail)

• The `domain` argument identifies the user alias's domain or the domain in the user's primary email address.
• The `userEmail` argument contains the unique email address that identifies the account.

Protocol

DELETE https://apps-apis.google.com/a/feeds/alias/2.0/the domain name/user email address

Java

import sample.appsforyourdomain.labs.provisioning.ProvisioningApiMultiDomainSampleClient;
...
ProvisioningApiMultiDomainSampleClient multiDomainClient = new ProvisioningApiMultiDomainSampleClient(adminEmail, adminPassword, domain, appName);
multiDomainClient.deleteAlias(String aliasEmail)

• The `aliasEmail` argument identifies the user’s email alias to be deleted.

Python

import gdata.apps.multidomain.client; 
...
multiDomainClient = gdata.apps.multidomain.client.MultiDomainProvisioningClient(domain=domain)
multiDomainClient.ClientLogin(email=email, password=password, source='apps')
multiDomainClient.DeleteAlias(email)

• The `email` argument identifies the alias to be deleted.

.NET

using Google.GData.Apps;
...
MultiDomainManagementService service = new MultiDomainManagementService(domain, applicationName);
service.setUserCredentials(userName, password);
service.DeleteDomainUserAlias(String domain, String aliasEmail)

• The `domain` argument identifies the user alias's domain or the domain in the user's primary email address.
• The `aliasEmail` argument contains the alias' email address.

Protocol

GET https://apps-apis.google.com/a/feeds/customer/2.0/customerId

<?xml version='1.0' encoding='UTF-8">
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/customer/2.0/C03az79cb</id>
<updated>2008-10-17T15:02:45.646Z</atom:updated>
<link rel='self' type='application/atom+xml'
href='https://apps-apis.google.com/a/feeds/customer/2.0/C03az79cb'/>
    <link rel='edit' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/customer/2.0/C03az79cb'/>
    <apps:property name="customerId" value="C03az79cb" />
    <apps:property name="name" value="example.com" />
    <apps:property name="description" value="The customerId of the
example.com account" />
    <apps:property name="customerOrgUnitName" value="example.com"
/>
    <apps:property name="customerOrgUnitDescription"
value="customer org unit for example.com account" />
</entry>

customerId

The `customerId` is the system's unique identifier for the Google Apps customer's account. This ID is used in all request and response operations for organizational units and users for the account's primary domain and, in the case of multiple domains, for any account's domain aliases. The customerId can be called by any domain administrator for this account. Note: The `customerId` parameter's format may change in future API releases. When making an API request, both formats are supported. But future API responses may contain a different `customerId` in the URL's response links than the `customerId` value used in your request. If your client application uses the request's `customerId` as a key value for persistent data, this key could break if the response returns a different `customerId` value

name

The name helps to identify the `customerId` to a specific Google Apps account. Initially, this property's value may be the account's domain name. The name should be no more than 128 characters.

description

The description is the descriptive text referring to the account's domain name. This property value may be an empty String if no description has been entered, and if entered, the description should be no more than 512 characters.

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName);
orgUnitClient.retrieveCustomerId(String domain)

• The `domain` argument is the nameof the domain.

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.RetrieveCustomerId()

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveCustomerId(String domain)

Protocol

POST https://apps-apis.google.com/a/feeds/orgunit/2.0/the customerId

POST https://apps-apis.google.com/a/feeds/orgunit/2.0/CO3az79cb

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/customer/2.0/C03az79cb</id>
    <apps:property name="name" value="Human Resources" />
    <apps:property name="description" value="The corporate human
resources organization" />
    <apps:property name="parentOrgUnitPath"
value="corp/Human+Resources" />
    <apps:property name="blockInheritance" value="false" />
</atom:entry>

name

The `name` is the simple organization unit text name, not the full path name. This parameter is required. The `name` is composed of unicode/UTF-8 characters and should be no more than 128 characters. The path name is unique and is case insensitive. The `name` cannot be blank or a series of spaces. Do not use spaces to distinguish one organization name from another. When a new organization unit is created or modified, its name is verified. For more naming guidelines, see Character Usage. We recommend using names that are descriptive of the organization's purpose, and names that are short in length for easier management. As a `name` property, the organization's name is not URL-encoded. But when listed in a path, for example the `parentOrgUnitPath`, each organization unit name in the path is subject to URL-encoding. In this example, the Human Resources organization is URL-encoded when in a parent organization's path, Human+Resources.

description

The `description` is the human readable text description of the organization unit. The `description` should be no more than 512 characters. This parameter is optional but strongly recommended.

parentOrgUnitPath

The `parentOrgUnitPath` is the full path of the parental tree to this organization unit. It does not include the specific organization unit name. The `orgUnitPath` parameter, used when calling specific organization units or users, is the full parent path with the organization unit's name. Path names are case insensitive. This parameter is required. If the parent organization unit is the top-level organization, it is represented as a forward slash, '/'.

blockInheritance

The `blockInheritance` parameter blocks policy setting inheritance from organization units higher in the organization tree. The value is either the boolean `true` or `false`. This parameter is optional, and the default is `false`.

<?xml version='1.0' encoding='UTF-8">
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name="OrgUnitPath" value="example.com/corp/Sales" />
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.createOrganizationUnit(String customerId, String orgUnitName, String parentOrgUnitPath, String description, Boolean blockInheritance)

• The `customerId` argument contains the ID of the Google Apps customer.
• The `orgUnitName` argument is the organization unit name.
• The `parentOrgUnitPath` argument is the full path of the parental tree to this organization unit.
• The `description` argument is the human readable text description of the organization unit.
• The `blockInheritance` argument blocks policy setting inheritance from organization units higher in the organization tree.

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.CreateOrgUnit(customer_id, name, parent_org_unit_path='/', description='', block_inheritance=False)

• The `customer_id` argument contains the ID of the Google Apps customer.
• The `name` argument is the organization unit name.
• The `parent_org_unit_path` argument is the full path of the parental tree to this organization unit.
• The `description` argument is the human readable text description of the organization unit.
• The `block_inheritance` argument blocks policy setting inheritance from organization units higher in the organization tree.

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.CreateOrganizationUnit(String customerId, String orgUnitName, String parentOrgUnitPath, String description, Boolean blockInheritance)

• The `customerId` argument contains the ID of the Google Apps customer.
• The `orgUnitName` argument is the organization unit name.
• The `parentOrgUnitPath` argument is the full path of the parental tree to this organization unit.
• The `description` argument is the human readable text description of the organization unit.
• The `blockInheritance` argument blocks policy setting inheritance from organization units higher in the organization tree.

Protocol

PUT https://apps-apis.google.com/a/feeds/orgunit/2.0/the customerId/full org unit path

PUT https://apps-apis.google.com/a/feeds/orgunit/2.0/CO3az79cb/Sales/Partners

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/customer/2.0/C03az79cb</id>
    <apps:property name="name" value="new organization unit's
name" />
    <apps:property name="description" value="new organization
description" />
    <apps:property name="parentOrgUnitPath" value="new parent
path/organization unit" />
    <apps:property name="blockInheritance" value="true or
false" />
</atom:entry>

<?xml version='1.0' encoding='UTF-8">
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
...
    <apps:property name="orgUnitPath" value="parent's
path/organization's unit name" />
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.updateOrganizationUnit(String customerId, String orgUnitPath, Map<OrgUnitProperty, String> attributes)

• The `customerId` argument contains the ID of the Google Apps customer.
• The `orgUnitPath` argument contains the full path name.
• The `attributes` argument is a map of OrgUnitProperty and value to be updated. The keys available are:

-NAME: The name of the organization unit.

-PARENT_ORG_UNIT_PATH: The full path of the parental tree to this organization unit.

-DESCRIPTION: Human readable text description of the organization unit.

-BLOCK_INHERITANCE: Blocks policy setting inheritance from organization units higher in the organization tree.

-USERS_TO_MOVE: A comma separated list of email addresses that are to be moved across orgUnits

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.UpdateOrgUnit(customer_id, org_unit_path, org_unit_entry)

• The `customer_id` argument contains the ID of the Google Apps customer.
• The `org_unit_path` argument contains the full path name.
• The `org_unit_entry` argument contains the updated organization unit.

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.UpdateOrganizationUnit(String customerId, String orgUnitPath, IDictionary attributes)

• The `customerId` argument uniquely identifies the Google Apps account.
• The `orgUnitPath` argument contains the path to the organization unit.
• The `attributes` argument contains the set of attributes to update.

Protocol

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.retrieveOrganizationUnit(String customerId, String orgUnitPath)

• The `customerId` argument contains the ID of the Google Apps customer.
• The `org_UnitPath` argument is the full path name of the organization.

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.RetrieveOrgUnit(customer_id, org_unit_path)

• The `customer_id` argument contains the ID of the Google Apps customer.
• The `org_unit_path` argument is the full path name of the organization.

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveOrganizationUnit(String customerId, String orgUnitPath)

• The `customerId` argument contains the ID of the Google Apps customer.
• The `org_UnitPath` argument is the full path name of the organization.

Protocol

GET https://apps-apis.google.com/a/feeds/orgunit/2.0/the customerId?get=all

<feed xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
...
  <openSearch:startIndex>1</openSearch:startIndex>
  <entry>
    <id>https://apps-apis.google.com/a/feeds/orgunit/2.0/the
customerId/NA_Sales</id>
...
    <apps:property name="name" value="NA_Sales" />
    <apps:property name="description" value="The North America
sales organization" />
    <apps:property name="orgUnitPath" value="NA_Sales" />
    <apps:property name="parentOrgUnitPath" value="" />
    <apps:property name="blockInheritance" value="false" />
  </entry>
</feed>

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.retrieveAllOrganizationUnits(String customerId)

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.RetrieveAllOrgUnits(customer_id)

ouclient.RetrievePageOfOrgUnits(customer_id, startKey=None)

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveAllOrganizationUnits(String customerId)

Protocol

GET https://apps-apis.google.com/a/feeds/orgunit/2.0/the customerId?get=children&orgUnitPath=the URL-encoded organization unit's path

<?xml version='1.0' encoding='UTF-8">
<feed xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<entry>
<id>https://apps-apis.google.com/a/feeds/orgunit/2.0/C03az79cb/EMEA/Sales&
lt;/id>
<updated>2008-10-17T15:02:45.646Z</atom:updated>
<link rel='self' type='application/atom+xml'
href='https://apps-apis.google.com/a/feeds/orgunit/2.0/C03az79cb/EMEA/Sales'/>
;
    <link rel='edit' type='application/atom+xml'
   
href='https://apps-apis.google.com/a/feeds/orgunit/2.0/C03az79cb/EMEA/Sales'/>
;
    <apps:property name="name" value="Sales" />
    <apps:property name="description" value="The EMEA sales
organization" />
    <apps:property name="orgUnitPath" value="EMEA/Sales"/>
    <apps:property name="parentOrgUnitPath" value="EMEA" />
    <apps:property name="blockInheritance" value="false" />
</entry>
<entry>
 ...
</entry>
 ...
</feed>

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.retrieveChildOrganizationUnits(String customerId, String orgUnitPath)

• The `customerId` argument uniquely identifies the Google Apps account.
• The `orgUnitPath` argument contains the path to the organization unit.

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.RetrieveSubOrgUnits(customer_id, org_unit_path)

• The `customer_id` argument contains the ID of the Google Apps customer.
• The `org_unit_path` argument is the full path name of the organization.

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveChildOrganizationUnits(String customerId, String orgUnitPath)

• The `customerId` argument uniquely identifies the Google Apps account.
• The `orgUnitPath` argument contains the path to the organization unit.

Protocol

DELETE https://apps-apis.google.com/a/feeds/orgunit/2.0/the customerId/the organization unit's path

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient;
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.deleteOrganizationUnit(String customerId, String orgUnitPath)

• The `customerId` argument uniquely identifies the Google Apps account.
• The `orgUnitPath` argument contains the path to the organization unit.

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.DeleteOrgUnit(customer_id, org_unit_path)

• The `customer_id` argument contains the ID of the Google Apps customer.
• The `org_unit_path` argument is the full path name of the organization.

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.DeleteOrganizationUnit(String customerId, String orgUnitPath)

• The `customerId` argument uniquely identifies the Google Apps account.
• The `orgUnitPath` argument contains the path to the organization unit.

Protocol

PUT https://apps-apis.google.com/a/feeds/orguser/2.0/the customerId/the organization user's email

PUT https://apps-apis.google.com/a/feeds/orguser/2.0/CO3az79cb/liz@example.com

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
...
    <apps:property name="oldOrgUnitPath" value="old
organization unit path" />
    <apps:property name="orgUnitPath" value="new organization
unit path" />
</atom:entry>

<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
...
    <apps:property name="orgUserEmail" value="liz@example.com"
/>
    <apps:property name="orgUnitPath" value="new_york/hr" />
</entry>

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.updateOrganizationUser(String customerId, String orgUserEmail, String oldOrgUnitPath, String newOrgUnitPath)

• The `customerId` argument uniquely identifies the Google Apps account.
• The `orgUserEmail` argument contains the email address of the user.
• The `oldOrgUnitPath` argument contains the path to the old organization unit.
• The `newOrgUnitPath` argument contains the path to the new organization unit.

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.UpdateOrgUser(customer_id, user_email, org_unit_path)

• The `customer_id` argument contains the ID of the Google Apps customer.
• The `user_email` argument contains the email address of the user.
• The `org_unit_path` argument is the full path name.

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.UpdateOrganizationUser(String customerId, String orgUserEmail, String newOrgUnitPath, String oldOrgUnitPath)

• The `customerId` argument uniquely identifies the Google Apps account.
• The `orgUserEmail` argument contains the email address of the user.
• The `newOrgUnitPath` argument contains the path to the new organization unit.
• The `oldOrgUnitPath` argument contains the path to the old organization unit.

Protocol

GET https://apps-apis.google.com/a/feeds/orguser/2.0/the customerId/organization user's email

<?xml version='1.0' encoding='UTF-8">
<entry xmlns='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
...
    <apps:property name="orgUserEmail" value="liz@example.com"/>
    <apps:property name="orgUnitPath" value="Sales/EMEA_Sales"/>
</entry>

orgUserEmail

Email address of the organization user. For example, liz@example.com.

orgUnitPath

Full path location of the organization user in the organization tree, including the organization unit's name. In the example above, liz@example.com is in the EMEA_Sales organization unit whose parent is the Sales organization unit.

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.retrieveOrganizationUser(String customerId, String orgUserEmail)

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.RetrieveOrgUser(customer_id, user_email)

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveOrganizationUser(String customerId, String orgUserEmail)

Protocol

GET https://apps-apis.google.com/a/feeds/orguser/2.0/the customerId?get=all

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
  <entry>
    <apps:property name="orgUserEmail" value="liz@example.com"
/>
    <apps:property name="orgUnitPath" value="new_york/hr" />
  </entry>
  <entry>
 ...
  </entry>
 ...
</feed>

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.retrieveAllOrganizationUsers(String customerId)

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.RetrieveAllOrgUsers(customer_id)

import gdata.apps.organization.service
...
ouclient = gdata.apps.organization.service.OrganizationService(email=email, domain=domain, password=password)
ouclient.ProgrammaticLogin()
ouclient.RetrievePageOfOrgUsers(customer_id, startKey=None)

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveAllOrganizationUsers(String customerId)

Protocol

GET https://apps-apis.google.com/a/feeds/orguser/2.0/the customerId?get=children&orgUnitPath=the URL-encoded full organization unit path

<?xml version='1.0' encoding='UTF-8">
<feed xmlns:atom='http://www.w3.org/2005/Atom'
xmlns:apps='http://schemas.google.com/apps/2006'>
<entry>
...
    <apps:property name="orgUserEmail" value="liz@example.com"/>
    <apps:property name="orgUnitPath" value="Sales/EMEA_Sales"/>
</entry>
<entry>
 ...
</entry>
 ...
</feed>

Java

import sample.appsforyourdomain.labs.provisioning.OrgManagementSampleClient; 
...
OrgManagementSampleClient orgUnitClient = new OrgManagementSampleClient(adminEmail, adminPassword, domain, appName); 
orgUnitClient.retrieveAllOrganizationUsersByOrgUnit(String customerId, String orgUnitPath)

Python

import gdata.apps.organization.client
...
ouclient = gdata.apps.organization.client.OrganizationUnitProvisioningClient(domain=domain)
ouclient.ClientLogin(email=email, password=password, source ='apps')
ouclient.RetrieveOrgUnitUsers(customer_id, org_unit_path)

.NET

using Google.GData.Apps;
...
OrganizationService service = new OrganizationService(domain, applicationName);
service.setUserCredentials(userName, password);
service.RetrieveAllOrganizationUsersByOrgUnit(String customerId, String orgUnitPath)

Java

try {
// Some API actions
} catch (AppsForYourDomainException e) {
if (e.getErrorCode() == AppsForYourDomainErrorCode.EntityDoesNotExist ) {
// Do some post-error processing or logging.
}
}

Python

try:

""" Some API actions """

except gdata.apps.service.AppsForYourDomainException , e:
print e # or process the exception in some other way

.NET

try
{
// Some API actions
}
catch (AppsException e)
{
if (e.ErrorCode == AppsException.EntityDoesNotExist)
{
// Do some post-error processing or logging.
}
}

PHP

try{
// Some API actions
} catch (Zend_Gdata_Gapps_ServiceException $e) {
if ($e->hasError(Zend_Gdata_Gapps_Error::ENTITY_DOES_NOT_EXIST)) {
// If this is an ENTITY_DOES_NOT_EXIST error, return null
return null;
}
else {
// Outherwise, just print the errors that occured and exit
foreach ($e->getErrors() as $error) {
echo "Error encountered: {$error->getReason()} ({$error->getErrorCode()})\n"
}
exit();
}
}