API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Resource types

  1. Asps
  2. Channels
  3. Chromeosdevices
  4. Customers
  5. DomainAliases
  6. Domains
  7. Groups
  8. Groups.aliases
  9. Members
  10. Mobiledevices
  11. Notifications
  12. Orgunits
  13. Privileges
  14. ResolvedAppAccessSettings
  15. Resources.buildings
  16. Resources.calendars
  17. Resources.features
  18. RoleAssignments
  19. Roles
  20. Schemas
  21. Tokens
  22. Users
  23. Users.aliases
  24. Users.photos
  25. VerificationCodes

Asps

For Asps Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /users/userKey/asps/codeId Delete an ASP issued by a user.
get GET  /users/userKey/asps/codeId Get information about an ASP issued by a user.
list GET  /users/userKey/asps List the ASPs issued by a user.

Channels

For Channels Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
stop POST  /channels/stop Stop watching resources through this channel.

Chromeosdevices

For Chromeosdevices Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
action POST  /customer/customerId/devices/chromeos/deviceId/action Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices.
get GET  /customer/customerId/devices/chromeos/deviceId Retrieves a Chrome OS device's properties.
list GET  /customer/customerId/devices/chromeos Retrieves a paginated list of Chrome OS devices within an account.
moveDevicesToOu POST  /customer/customerId/devices/chromeos/moveDevicesToOu Move or insert multiple Chrome OS devices to an organizational unit.
You can move up to 50 devices at once.

Required query parameters: orgUnitPath

patch PATCH  /customer/customerId/devices/chromeos/deviceId Updates a device's annotatedUser, annotatedLocation, or notes properties. This method supports patch semantics.
update PUT  /customer/customerId/devices/chromeos/deviceId Updates a device's annotatedUser, annotatedLocation, or notes properties.

Customers

For Customers Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
get GET  /customers/customerKey Retrieves a customer.
patch PATCH  /customers/customerKey Updates a customer. This method supports patch semantics.
update PUT  /customers/customerKey Updates a customer.

DomainAliases

For DomainAliases Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/domainaliases/domainAliasName Deletes a Domain Alias of the customer.
get GET  /customer/customer/domainaliases/domainAliasName Retrieves a domain alias of the customer.
insert POST  /customer/customer/domainaliases Inserts a Domain alias of the customer.
list GET  /customer/customer/domainaliases Lists the domain aliases of the customer.

Domains

For Domains Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/domains/domainName Deletes a domain of the customer.
get GET  /customer/customer/domains/domainName Retrieves a domain of the customer.
insert POST  /customer/customer/domains Inserts a domain of the customer.
list GET  /customer/customer/domains Lists the domains of the customer.

Groups

For Groups Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /groups/groupKey Deletes a group.
get GET  /groups/groupKey Retrieves a group's properties.
insert POST  /groups Creates a group.
list GET  /groups Retrieve all groups of a domain or of a user given a userKey (paginated)
patch PATCH  /groups/groupKey Updates a group's properties. This method supports patch semantics.
update PUT  /groups/groupKey Updates a group's properties.

Groups.aliases

For Groups.aliases Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /groups/groupKey/aliases/alias Removes an alias.
insert POST  /groups/groupKey/aliases Adds an alias for the group.
list GET  /groups/groupKey/aliases Lists all aliases for a group.

Members

For Members Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /groups/groupKey/members/memberKey Removes a member from a group.
get GET  /groups/groupKey/members/memberKey Retrieves a group member's properties.
hasMember GET  /groups/groupKey/hasMember/memberKey Checks whether the given user is a member of the group. Membership can be direct or nested.
insert POST  /groups/groupKey/members Adds a user to the specified group.
list GET  /groups/groupKey/members Retrieves a paginated list of all members in a group.
patch PATCH  /groups/groupKey/members/memberKey Updates the membership properties of a user in the specified group. This method supports patch semantics.
update PUT  /groups/groupKey/members/memberKey Updates the membership of a user in the specified group.

Mobiledevices

For Mobiledevices Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
action POST  /customer/customerId/devices/mobile/resourceId/action Takes an action that affects a mobile device. For example, remotely wiping a device.
delete DELETE  /customer/customerId/devices/mobile/resourceId Removes a mobile device.
get GET  /customer/customerId/devices/mobile/resourceId Retrieves a mobile device's properties.
list GET  /customer/customerId/devices/mobile Retrieves a paginated list of all mobile devices for an account.

Notifications

For Notifications Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/notifications/notificationId Deletes a notification
get GET  /customer/customer/notifications/notificationId Retrieves a notification.
list GET  /customer/customer/notifications Retrieves a list of notifications.
patch PATCH  /customer/customer/notifications/notificationId Updates a notification. This method supports patch semantics.
update PUT  /customer/customer/notifications/notificationId Updates a notification.

Orgunits

For Orgunits Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customerId/orgunits/orgUnitPath* Removes an organizational unit.
get GET  /customer/customerId/orgunits/orgUnitPath* Retrieves an organizational unit.
insert POST  /customer/customerId/orgunits Adds an organizational unit.
list GET  /customer/customerId/orgunits Retrieves a list of all organizational units for an account.
patch PATCH  /customer/customerId/orgunits/orgUnitPath* Updates an organizational unit. This method supports patch semantics.
update PUT  /customer/customerId/orgunits/orgUnitPath* Updates an organizational unit.

Privileges

For Privileges Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
list GET  /customer/customer/roles/ALL/privileges Retrieves a paginated list of all privileges for a customer.

ResolvedAppAccessSettings

For ResolvedAppAccessSettings Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
GetSettings GET  /resolvedappaccesssettings Retrieves resolved app access settings of the logged in user.
ListTrustedApps GET  /trustedapps Retrieves the list of apps trusted by the admin of the logged in user.

Resources.buildings

For Resources.buildings Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/resources/buildings/buildingId Deletes a building.
get GET  /customer/customer/resources/buildings/buildingId Retrieves a building.
insert POST  /customer/customer/resources/buildings Inserts a building.
list GET  /customer/customer/resources/buildings Retrieves a list of buildings for an account.
patch PATCH  /customer/customer/resources/buildings/buildingId Updates a building. This method supports patch semantics.
update PUT  /customer/customer/resources/buildings/buildingId Updates a building.

Resources.calendars

For Resources.calendars Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/resources/calendars/calendarResourceId Deletes a calendar resource.
get GET  /customer/customer/resources/calendars/calendarResourceId Retrieves a calendar resource.
insert POST  /customer/customer/resources/calendars Inserts a calendar resource.
list GET  /customer/customer/resources/calendars Retrieves a list of calendar resources for an account.
patch PATCH  /customer/customer/resources/calendars/calendarResourceId Updates a calendar resource.

This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. This method supports patch semantics.
update PUT  /customer/customer/resources/calendars/calendarResourceId Updates a calendar resource.

This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved.

Resources.features

For Resources.features Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/resources/features/featureKey Deletes a feature.
get GET  /customer/customer/resources/features/featureKey Retrieves a feature.
insert POST  /customer/customer/resources/features Inserts a feature.
list GET  /customer/customer/resources/features Retrieves a list of features for an account.
patch PATCH  /customer/customer/resources/features/featureKey Updates a feature. This method supports patch semantics.
rename POST  /customer/customer/resources/features/oldName/rename Renames a feature.
update PUT  /customer/customer/resources/features/featureKey Updates a feature.

RoleAssignments

For RoleAssignments Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/roleassignments/roleAssignmentId Deletes a role assignment.
get GET  /customer/customer/roleassignments/roleAssignmentId Retrieve a role assignment.
insert POST  /customer/customer/roleassignments Creates a role assignment.
list GET  /customer/customer/roleassignments Retrieves a paginated list of all roleAssignments.

Roles

For Roles Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customer/roles/roleId Deletes a role.
get GET  /customer/customer/roles/roleId Retrieves a role.
insert POST  /customer/customer/roles Creates a role.
list GET  /customer/customer/roles Retrieves a paginated list of all the roles in a domain.
patch PATCH  /customer/customer/roles/roleId Updates a role. This method supports patch semantics.
update PUT  /customer/customer/roles/roleId Updates a role.

Schemas

For Schemas Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /customer/customerId/schemas/schemaKey Delete schema
get GET  /customer/customerId/schemas/schemaKey Retrieve schema
insert POST  /customer/customerId/schemas Create schema.
list GET  /customer/customerId/schemas Retrieve all schemas for a customer
patch PATCH  /customer/customerId/schemas/schemaKey Update schema. This method supports patch semantics.
update PUT  /customer/customerId/schemas/schemaKey Update schema

Tokens

For Tokens Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /users/userKey/tokens/clientId Delete all access tokens issued by a user for an application.
get GET  /users/userKey/tokens/clientId Get information about an access token issued by a user.
list GET  /users/userKey/tokens Returns the set of tokens specified user has issued to 3rd party applications.

Users

For Users Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /users/userKey Deletes a user.
get GET  /users/userKey Retrieves a user.
insert POST  /users Creates a user.
list GET  /users Retrieves a paginated list of either deleted users or all users in a domain.
makeAdmin POST  /users/userKey/makeAdmin Makes a user a super administrator.
patch PATCH  /users/userKey Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance.
undelete POST  /users/userKey/undelete Undeletes a deleted user.
update PUT  /users/userKey Updates a user.

This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to null will be cleared.
watch POST  /users/watch Watch for changes in users list

Users.aliases

For Users.aliases Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /users/userKey/aliases/alias Removes an alias.
insert POST  /users/userKey/aliases Adds an alias.
list GET  /users/userKey/aliases Lists all aliases for a user.
watch POST  /users/userKey/aliases/watch Watch for changes in user aliases list

Users.photos

For Users.photos Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
delete DELETE  /users/userKey/photos/thumbnail Removes the user's photo.
get GET  /users/userKey/photos/thumbnail Retrieves the user's photo.
patch PATCH  /users/userKey/photos/thumbnail Adds a photo for the user. This method supports patch semantics.
update PUT  /users/userKey/photos/thumbnail Adds a photo for the user.

VerificationCodes

For VerificationCodes Resource details, see the resource representation page.

Method HTTP request Description
URIs relative to https://www.googleapis.com/admin/directory/v1, unless otherwise noted
generate POST  /users/userKey/verificationCodes/generate Generate new backup verification codes for the user.
invalidate POST  /users/userKey/verificationCodes/invalidate Invalidate the current backup verification codes for the user.
list GET  /users/userKey/verificationCodes Returns the current set of valid backup verification codes for the specified user.

Send feedback about...

This page
Documentation feedback
Directory API
Directory API
Product feedback
Need help? Visit our support page.