Directory API: Revision History

This page lists the Directory API (v1) changes and documentation updates.

August 11, 2014

Several new fields have been added to the Mobiledevices resource. The new fields are:

  • serialNumber
  • imei
  • meid
  • wifiMacAddress
  • networkOperator
  • defaultLanguage
  • managedAccountIsOnOwnerProfile
  • deviceCompromisedStatus
  • buildNumber
  • kernelVersion
  • basebandVersion

The Chromeosdevices resource also has new fields for recentUsers and the device's ethernetMacAddress.

Feb 24, 2014

The users.update method behavior has been slightly changed to accomodate delegated administrator access to the API. Only fields the authenticated user has access to can be specified in the request and only fields that have been updated are included in the response.

Jan 27, 2014

The Directory API now supports Push Notifications for changes to users and aliases. Developers no longer need to poll resources to detect changes. You can create a notification channel using the and methods. You can stop receiving notifications with the channels.stop method.

Structured search queries for users are now available via the users.list method.

April, 2013

This section highlights some of the differences between the Directory API and the deprecated Provisioning API (v2).

API Features Directory API Deprecated Provisioning API (v2)
Account's domain name Directory API user's primaryEmail property holds the account's primary domain name. Provisioning API request URL's domain property holds the account's primary domain name.
Administrator Directory API isAdmin property has a boolean true, false value. The isAdmin property can only be edited in the 'Make a user an administrator' operation. If edited in the 'Create a user account' or 'Update a user account' operations, the edit is ignored by the API service. Provisioning API isAdmin property has a boolean true, false value. The property can be edited when the user is created or updated.
A customerId unique identifier Directory API returns a customerId unique identifier property when a user is retrieved for an account with a single or multiple organizational units. Provisioning API returns a customerId for accounts with an organizational unit hierarchy.
Deleted user list Directory API returns a list of users deleted from the account or a subdomain within the span of the last 20 days. Provisioning API does not support this feature.
Disk space Not applicable in this version of the Directory API. Provisioning API apps:quota that sets the user's disk space quota is no longer available. Setting a customer quota, different than 25600MB, has no effect.
Devices Directory API Google Chrome devices and Mobile Devices support the management of retrieving, adding, updating, and deleting your account's various devices. Provisioning API does not support these features.
Email aliases outside of an account Directory API users and groups support listing non editable alias email addresses that are outside of the account. These are functioning email addresses used by a user or a group on a reqular basis. Provisioning API does not support this feature.
Group aliases Directory API creates, lists, and deletes a group's aliases. Provisioning API supports managing groups but does not include group aliases.
Hash function Directory API hashFunction property holds the hash format of the password property. The values can be set to either SHA-1, MD5, or CRYPT hash formats. Provisioning API hashFunctionName attribute is a part of the password tag. The values can be either SHA-1, MD5, or CRYPT hash formats.
Organizational units Directory API uses the orgUnitPath property when setting a new user. Provisioning API has two steps for creating a user in an organizational unit. First the user account is created and then the user is assigned to an organizational unit.
Suspend a user Directory API suspends a user's account either when creating or updating the user's account using the suspended property. The reason for the suspension is also retained by the API in the suspensionReason property. Provisioning API uses the operation that suspends a user's account.
Undelete a user Directory API undeletes a previously deleted user account within 20 days of the deletion. Provisioning API restores a suspended user account to an active state within the suspension period.
User aliases Directory API supports user alias for a single or multiple domain account. A user alias is an alternate email address that uses the same mailbox used by the user's primary email address. A user's alias can be associated with a different account domain than that domain used by the user's primary email address. The account can have single or multiple domains. The API does not use the concept of a 'nickname' for a single domain. Provisioning API manages a single domain account's nicknames, and, in the case of an account with multple domains, the Provisioning API supports user aliases.
User list's search, sorting, and list order Directory API can search for users by primary email address, given name, or family name. In addition, the API can return lists of a domain's users sorted by the user's primary email address, given name, or family name. And, you have the option to list these results in ascending or descending order. Provisioning API does not support these features.