@@ -0,0 +1,4182 @@
2+ "kind": "discovery#restDescription",
3+ "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/uQEY1lxUpBjGfWxd7mioMh_V8P8\"",
4+ "discoveryVersion": "v1",
5+ "id": "admin:directory_v1",
7+ "canonicalName": "directory",
8+ "version": "directory_v1",
9+ "revision": "20150720",
10+ "title": "Admin Directory API",
11+ "description": "The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.",
12+ "ownerDomain": "google.com",
13+ "ownerName": "Google",
14+ "packagePath": "admin",
16+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
17+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
19+ "documentationLink": "https://developers.google.com/admin-sdk/directory/",
21+ "baseUrl": "https://www.googleapis.com/admin/directory/v1/",
22+ "basePath": "/admin/directory/v1/",
23+ "rootUrl": "https://www.googleapis.com/",
24+ "servicePath": "admin/directory/v1/",
25+ "batchPath": "batch",
29+ "description": "Data format for the response.",
34+ "enumDescriptions": [
35+ "Responses with Content-Type of application/json"
41+ "description": "Selector specifying which fields to include in a partial response.",
46+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
51+ "description": "OAuth 2.0 token for the current user.",
56+ "description": "Returns response with indentations and line breaks.",
62+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
67+ "description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
74+ "https://www.googleapis.com/auth/admin.directory.device.chromeos": {
75+ "description": "View and manage your Chrome OS devices' metadata"
77+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": {
78+ "description": "View your Chrome OS devices' metadata"
80+ "https://www.googleapis.com/auth/admin.directory.device.mobile": {
81+ "description": "View and manage your mobile devices' metadata"
83+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action": {
84+ "description": "Manage your mobile devices by performing administrative tasks"
86+ "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly": {
87+ "description": "View your mobile devices' metadata"
89+ "https://www.googleapis.com/auth/admin.directory.group": {
90+ "description": "View and manage the provisioning of groups on your domain"
92+ "https://www.googleapis.com/auth/admin.directory.group.member": {
93+ "description": "View and manage group subscriptions on your domain"
95+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly": {
96+ "description": "View group subscriptions on your domain"
98+ "https://www.googleapis.com/auth/admin.directory.group.readonly": {
99+ "description": "View groups on your domain"
101+ "https://www.googleapis.com/auth/admin.directory.notifications": {
102+ "description": "View and manage notifications received on your domain"
104+ "https://www.googleapis.com/auth/admin.directory.orgunit": {
105+ "description": "View and manage organization units on your domain"
107+ "https://www.googleapis.com/auth/admin.directory.orgunit.readonly": {
108+ "description": "View organization units on your domain"
110+ "https://www.googleapis.com/auth/admin.directory.user": {
111+ "description": "View and manage the provisioning of users on your domain"
113+ "https://www.googleapis.com/auth/admin.directory.user.alias": {
114+ "description": "View and manage user aliases on your domain"
116+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly": {
117+ "description": "View user aliases on your domain"
119+ "https://www.googleapis.com/auth/admin.directory.user.readonly": {
120+ "description": "View users on your domain"
122+ "https://www.googleapis.com/auth/admin.directory.user.security": {
123+ "description": "Manage data access permissions for users on your domain"
125+ "https://www.googleapis.com/auth/admin.directory.userschema": {
126+ "description": "View and manage the provisioning of user schemas on your domain"
128+ "https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
129+ "description": "View user schemas on your domain"
138+ "description": "JSON template for Alias object in Directory API.",
142+ "description": "A alias email"
146+ "description": "ETag of the resource."
150+ "description": "Unique id of the group (Read-only) Unique id of the user (Read-only)"
154+ "description": "Kind of resource this is.",
155+ "default": "admin#directory#alias"
159+ "description": "Group's primary email (Read-only) User's primary email (Read-only)"
166+ "description": "JSON response template to list aliases in Directory API.",
170+ "description": "List of alias objects.",
177+ "description": "ETag of the resource."
181+ "description": "Kind of resource this is.",
182+ "default": "admin#directory#aliases"
189+ "description": "The template that returns individual ASP (Access Code) data.",
193+ "description": "The unique ID of the ASP.",
198+ "description": "The time when the ASP was created. Expressed in Unix time format.",
203+ "description": "ETag of the ASP."
207+ "description": "The type of the API resource. This is always admin#directory#asp.",
208+ "default": "admin#directory#asp"
212+ "description": "The time when the ASP was last used. Expressed in Unix time format.",
217+ "description": "The name of the application that the user, represented by their userId, entered when the ASP was created."
221+ "description": "The unique ID of the user who issued the ASP."
231+ "description": "ETag of the resource."
235+ "description": "A list of ASP resources.",
242+ "description": "The type of the API resource. This is always admin#directory#aspList.",
243+ "default": "admin#directory#aspList"
250+ "description": "An notification channel used to watch for resource changes.",
254+ "description": "The address where notifications are delivered for this channel."
258+ "description": "Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.",
263+ "description": "A UUID or similar unique string that identifies this channel."
267+ "description": "Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string \"api#channel\".",
268+ "default": "api#channel"
272+ "description": "Additional parameters controlling delivery channel behavior. Optional.",
273+ "additionalProperties": {
275+ "description": "Declares a new parameter by name."
280+ "description": "A Boolean value to indicate whether payload is wanted. Optional."
284+ "description": "An opaque ID that identifies the resource being watched on this channel. Stable across different API versions."
288+ "description": "A version-specific identifier for the watched resource."
292+ "description": "An arbitrary string delivered to the target address with each notification delivered over this channel. Optional."
296+ "description": "The type of delivery mechanism used for this channel."
301+ "id": "ChromeOsDevice",
303+ "description": "JSON template for Chrome Os Device resource in Directory API.",
305+ "activeTimeRanges": {
307+ "description": "List of active time ranges (Read-only)",
313+ "description": "Duration in milliseconds",
318+ "description": "Date of usage",
324+ "annotatedAssetId": {
326+ "description": "AssetId specified during enrollment or through later annotation"
328+ "annotatedLocation": {
330+ "description": "Address or location of the device as noted by the administrator"
334+ "description": "User of the device"
338+ "description": "Chromebook boot mode (Read-only)"
342+ "description": "Unique identifier of Chrome OS Device (Read-only)"
346+ "description": "ETag of the resource."
348+ "ethernetMacAddress": {
350+ "description": "Chromebook Mac Address on ethernet network interface (Read-only)"
352+ "firmwareVersion": {
354+ "description": "Chromebook firmware version (Read-only)"
358+ "description": "Kind of resource this is.",
359+ "default": "admin#directory#chromeosdevice"
361+ "lastEnrollmentTime": {
363+ "description": "Date and time the device was last enrolled (Read-only)",
364+ "format": "date-time"
368+ "description": "Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)",
369+ "format": "date-time"
373+ "description": "Chromebook Mac Address on wifi network interface (Read-only)"
377+ "description": "Mobile Equipment identifier for the 3G mobile card in the Chromebook (Read-only)"
381+ "description": "Chromebook Model (Read-only)"
385+ "description": "Notes added by the administrator"
389+ "description": "Chromebook order number (Read-only)"
393+ "description": "OrgUnit of the device"
397+ "description": "Chromebook Os Version (Read-only)"
399+ "platformVersion": {
401+ "description": "Chromebook platform version (Read-only)"
405+ "description": "List of recent device users, in descending order by last login time (Read-only)",
411+ "description": "Email address of the user. Present only if the user type is managed"
415+ "description": "The type of the user"
422+ "description": "Chromebook serial number (Read-only)"
426+ "description": "status of the device (Read-only)"
430+ "description": "Final date the device will be supported (Read-only)",
431+ "format": "date-time"
435+ "description": "Will Chromebook auto renew after support end date (Read-only)"
439+ "ChromeOsDevices": {
440+ "id": "ChromeOsDevices",
442+ "description": "JSON response template for List Chrome OS Devices operation in Directory API.",
444+ "chromeosdevices": {
446+ "description": "List of Chrome OS Device objects.",
448+ "$ref": "ChromeOsDevice"
453+ "description": "ETag of the resource."
457+ "description": "Kind of resource this is.",
458+ "default": "admin#directory#chromeosdevices"
462+ "description": "Token used to access next page of this result."
469+ "description": "JSON template for Group resource in Directory API.",
473+ "description": "Is the group created by admin (Read-only) *"
477+ "description": "List of aliases (Read-only)",
484+ "description": "Description of the group"
486+ "directMembersCount": {
488+ "description": "Group direct members count",
493+ "description": "Email of Group",
496+ "directory.groups.insert"
502+ "description": "ETag of the resource."
506+ "description": "Unique identifier of Group (Read-only)"
510+ "description": "Kind of resource this is.",
511+ "default": "admin#directory#group"
515+ "description": "Group name"
517+ "nonEditableAliases": {
519+ "description": "List of non editable aliases (Read-only)",
529+ "description": "JSON response template for List Groups operation in Directory API.",
533+ "description": "ETag of the resource."
537+ "description": "List of group objects.",
544+ "description": "Kind of resource this is.",
545+ "default": "admin#directory#groups"
549+ "description": "Token used to access next page of this result."
556+ "description": "JSON template for Member resource in Directory API.",
560+ "description": "Email of member (Read-only)"
564+ "description": "ETag of the resource."
568+ "description": "Unique identifier of customer member (Read-only) Unique identifier of group (Read-only) Unique identifier of member (Read-only)"
572+ "description": "Kind of resource this is.",
573+ "default": "admin#directory#member"
577+ "description": "Role of member"
581+ "description": "Type of member (Immutable)"
588+ "description": "JSON response template for List Members operation in Directory API.",
592+ "description": "ETag of the resource."
596+ "description": "Kind of resource this is.",
597+ "default": "admin#directory#members"
601+ "description": "List of member objects.",
608+ "description": "Token used to access next page of this result."
613+ "id": "MobileDevice",
615+ "description": "JSON template for Mobile Device resource in Directory API.",
619+ "description": "Adb (USB debugging) enabled or disabled on device (Read-only)"
623+ "description": "List of applications installed on Mobile Device",
629+ "description": "Display name of application"
633+ "description": "Package name of application"
637+ "description": "List of Permissions for application",
644+ "description": "Version code of application",
649+ "description": "Version name of application"
654+ "basebandVersion": {
656+ "description": "Mobile Device Baseband version (Read-only)"
660+ "description": "Mobile Device Build number (Read-only)"
662+ "defaultLanguage": {
664+ "description": "The default locale used on the Mobile Device (Read-only)"
666+ "developerOptionsStatus": {
668+ "description": "Developer options enabled or disabled on device (Read-only)"
670+ "deviceCompromisedStatus": {
672+ "description": "Mobile Device compromised status (Read-only)"
676+ "description": "Mobile Device serial number (Read-only)"
680+ "description": "List of owner user's email addresses (Read-only)",
687+ "description": "ETag of the resource."
691+ "description": "Date and time the device was first synchronized with the policy settings in the Google Apps administrator control panel (Read-only)",
692+ "format": "date-time"
696+ "description": "Mobile Device Hardware Id (Read-only)"
700+ "description": "Mobile Device IMEI number (Read-only)"
704+ "description": "Mobile Device Kernel version (Read-only)"
708+ "description": "Kind of resource this is.",
709+ "default": "admin#directory#mobiledevice"
713+ "description": "Date and time the device was last synchronized with the policy settings in the Google Apps administrator control panel (Read-only)",
714+ "format": "date-time"
716+ "managedAccountIsOnOwnerProfile": {
718+ "description": "Boolean indicating if this account is on owner/primary profile or not (Read-only)"
722+ "description": "Mobile Device MEID number (Read-only)"
726+ "description": "Name of the model of the device"
730+ "description": "List of owner user's names (Read-only)",
735+ "networkOperator": {
737+ "description": "Mobile Device mobile or network operator (if available) (Read-only)"
741+ "description": "Name of the mobile operating system"
743+ "otherAccountsInfo": {
745+ "description": "List of accounts added on device (Read-only)",
752+ "description": "Unique identifier of Mobile Device (Read-only)"
756+ "description": "Mobile Device SSN or Serial Number (Read-only)"
760+ "description": "Status of the device (Read-only)"
762+ "supportsWorkProfile": {
764+ "description": "Work profile supported on device (Read-only)"
768+ "description": "The type of device (Read-only)"
770+ "unknownSourcesStatus": {
772+ "description": "Unknown sources enabled or disabled on device (Read-only)"
776+ "description": "Mobile Device user agent"
780+ "description": "Mobile Device WiFi MAC address (Read-only)"
784+ "MobileDeviceAction": {
785+ "id": "MobileDeviceAction",
787+ "description": "JSON request template for firing commands on Mobile Device in Directory Devices API.",
791+ "description": "Action to be taken on the Mobile Device",
794+ "directory.mobiledevices.action"
801+ "id": "MobileDevices",
803+ "description": "JSON response template for List Mobile Devices operation in Directory API.",
807+ "description": "ETag of the resource."
811+ "description": "Kind of resource this is.",
812+ "default": "admin#directory#mobiledevices"
816+ "description": "List of Mobile Device objects.",
818+ "$ref": "MobileDevice"
823+ "description": "Token used to access next page of this result."
828+ "id": "Notification",
830+ "description": "Template for a notification resource.",
834+ "description": "Body of the notification (Read-only)"
838+ "description": "ETag of the resource."
842+ "description": "Address from which the notification is received (Read-only)"
846+ "description": "Boolean indicating whether the notification is unread or not.",
849+ "directory.notifications.patch",
850+ "directory.notifications.update"
856+ "description": "The type of the resource.",
857+ "default": "admin#directory#notification"
864+ "description": "Time at which notification was sent (Read-only)",
865+ "format": "date-time"
869+ "description": "Subject of the notification (Read-only)"
874+ "id": "Notifications",
876+ "description": "Template for notifications list response.",
880+ "description": "ETag of the resource."
884+ "description": "List of notifications in this page.",
886+ "$ref": "Notification"
891+ "description": "The type of the resource.",
892+ "default": "admin#directory#notifications"
896+ "description": "Token for fetching the next page of notifications."
898+ "unreadNotificationsCount": {
900+ "description": "Number of unread notification for the domain.",
908+ "description": "JSON template for Org Unit resource in Directory API.",
910+ "blockInheritance": {
912+ "description": "Should block inheritance"
916+ "description": "Description of OrgUnit"
920+ "description": "ETag of the resource."
924+ "description": "Kind of resource this is.",
925+ "default": "admin#directory#orgUnit"
929+ "description": "Name of OrgUnit",
932+ "directory.orgunits.insert"
938+ "description": "Id of OrgUnit"
942+ "description": "Path of OrgUnit"
944+ "parentOrgUnitId": {
946+ "description": "Id of parent OrgUnit"
948+ "parentOrgUnitPath": {
950+ "description": "Path of parent OrgUnit"
957+ "description": "JSON response template for List Organization Units operation in Directory API.",
961+ "description": "ETag of the resource."
965+ "description": "Kind of resource this is.",
966+ "default": "admin#directory#orgUnits"
968+ "organizationUnits": {
970+ "description": "List of user objects.",
980+ "description": "JSON template for Schema resource in Directory API.",
984+ "description": "ETag of the resource."
988+ "description": "Fields of Schema",
990+ "$ref": "SchemaFieldSpec"
994+ "directory.schemas.insert",
995+ "directory.schemas.update"
1001+ "description": "Kind of resource this is.",
1002+ "default": "admin#directory#schema"
1006+ "description": "Unique identifier of Schema (Read-only)"
1010+ "description": "Schema name",
1013+ "directory.schemas.insert"
1019+ "SchemaFieldSpec": {
1020+ "id": "SchemaFieldSpec",
1022+ "description": "JSON template for FieldSpec resource for Schemas in Directory API.",
1026+ "description": "ETag of the resource."
1030+ "description": "Unique identifier of Field (Read-only)"
1034+ "description": "Name of the field.",
1037+ "directory.schemas.insert",
1038+ "directory.schemas.update"
1044+ "description": "Type of the field.",
1047+ "directory.schemas.insert",
1048+ "directory.schemas.update"
1054+ "description": "Boolean specifying whether the field is indexed or not.",
1059+ "description": "Kind of resource this is.",
1060+ "default": "admin#directory#schema#fieldspec"
1064+ "description": "Boolean specifying whether this is a multi-valued field or not."
1066+ "numericIndexingSpec": {
1068+ "description": "Indexing spec for a numeric field. By default, only exact match queries will be supported for numeric fields. Setting the numericIndexingSpec allows range queries to be supported.",
1072+ "description": "Maximum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
1077+ "description": "Minimum value of this field. This is meant to be indicative rather than enforced. Values outside this range will still be indexed, but search may not be as performant.",
1082+ "readAccessType": {
1084+ "description": "Read ACLs on the field specifying who can view values of this field. Valid values are \"ALL_DOMAIN_USERS\" and \"ADMINS_AND_SELF\".",
1085+ "default": "ALL_DOMAIN_USERS"
1092+ "description": "JSON response template for List Schema operation in Directory API.",
1096+ "description": "ETag of the resource."
1100+ "description": "Kind of resource this is.",
1101+ "default": "admin#directory#schemas"
1105+ "description": "List of UserSchema objects.",
1115+ "description": "JSON template for token resource in Directory API.",
1119+ "description": "Whether the application is registered with Google. The value is true if the application has an anonymous Client ID."
1123+ "description": "The Client ID of the application the token is issued to."
1127+ "description": "The displayable name of the application the token is issued to."
1131+ "description": "ETag of the resource."
1135+ "description": "The type of the API resource. This is always admin#directory#token.",
1136+ "default": "admin#directory#token"
1140+ "description": "Whether the token is issued to an installed application. The value is true if the application is installed to a desktop or mobile device."
1144+ "description": "A list of authorization scopes the application is granted.",
1151+ "description": "The unique ID of the user that issued the token."
1158+ "description": "JSON response template for List tokens operation in Directory API.",
1162+ "description": "ETag of the resource."
1166+ "description": "A list of Token resources.",
1173+ "description": "The type of the API resource. This is always admin#directory#tokenList.",
1174+ "default": "admin#directory#tokenList"
1181+ "description": "JSON template for User object in Directory API.",
1188+ "description": "Indicates if user has agreed to terms (Read-only)"
1192+ "description": "List of aliases (Read-only)",
1197+ "changePasswordAtNextLogin": {
1199+ "description": "Boolean indicating if the user should change password in next login"
1203+ "description": "User's Google account creation time. (Read-only)",
1204+ "format": "date-time"
1208+ "description": "Custom fields of the user.",
1209+ "additionalProperties": {
1210+ "$ref": "UserCustomProperties"
1215+ "description": "CustomerId of User (Read-only)"
1219+ "format": "date-time"
1226+ "description": "ETag of the resource."
1233+ "description": "Hash function name for password. Supported are MD5, SHA-1 and crypt"
1237+ "description": "Unique identifier of User (Read-only)"
1242+ "includeInGlobalAddressList": {
1244+ "description": "Boolean indicating if user is included in Global Address List"
1248+ "description": "Boolean indicating if ip is whitelisted"
1252+ "description": "Boolean indicating if the user is admin (Read-only)"
1254+ "isDelegatedAdmin": {
1256+ "description": "Boolean indicating if the user is delegated admin (Read-only)"
1258+ "isMailboxSetup": {
1260+ "description": "Is mailbox setup (Read-only)"
1264+ "description": "Kind of resource this is.",
1265+ "default": "admin#directory#user"
1269+ "description": "User's last login time. (Read-only)",
1270+ "format": "date-time"
1273+ "$ref": "UserName",
1274+ "description": "User's name",
1277+ "directory.users.insert"
1281+ "nonEditableAliases": {
1283+ "description": "List of non editable aliases (Read-only)",
1293+ "description": "OrgUnit of User"
1300+ "description": "User's password",
1303+ "directory.users.insert"
1312+ "description": "username of User",
1315+ "directory.users.insert"
1324+ "description": "Indicates if user is suspended"
1326+ "suspensionReason": {
1328+ "description": "Suspension reason if user is suspended (Read-only)"
1330+ "thumbnailPhotoEtag": {
1332+ "description": "ETag of the user's photo (Read-only)"
1334+ "thumbnailPhotoUrl": {
1336+ "description": "Photo Url of the user (Read-only)"
1346+ "description": "JSON template for About (notes) of a user in Directory API.",
1350+ "description": "About entry can have a type which indicates the content type. It can either be plain or html. By default, notes contents are assumed to contain plain text."
1354+ "description": "Actual value of notes."
1359+ "id": "UserAddress",
1361+ "description": "JSON template for address.",
1365+ "description": "Country."
1369+ "description": "Country code."
1373+ "description": "Custom type."
1375+ "extendedAddress": {
1377+ "description": "Extended Address."
1381+ "description": "Formatted address."
1385+ "description": "Locality."
1389+ "description": "Other parts of address."
1393+ "description": "Postal code."
1397+ "description": "If this is user's primary address. Only one entry could be marked as primary."
1401+ "description": "Region."
1403+ "sourceIsStructured": {
1405+ "description": "User supplied address was structured. Structured addresses are NOT supported at this time. You might be able to write structured addresses, but any values will eventually be clobbered."
1409+ "description": "Street."
1413+ "description": "Each entry can have a type which indicates standard values of that entry. For example address could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such type should have the CUSTOM value as type and also have a customType value."
1417+ "UserCustomProperties": {
1418+ "id": "UserCustomProperties",
1420+ "description": "JSON template for a set of custom properties (i.e. all fields in a particular schema)",
1421+ "additionalProperties": {
1428+ "description": "JSON template for an email.",
1432+ "description": "Email id of the user."
1436+ "description": "Custom Type."
1440+ "description": "If this is user's primary email. Only one entry could be marked as primary."
1444+ "description": "Each entry can have a type which indicates standard types of that entry. For example email could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value Such types should have the CUSTOM value as type and also have a customType value."
1448+ "UserExternalId": {
1449+ "id": "UserExternalId",
1451+ "description": "JSON template for an externalId entry.",
1455+ "description": "Custom type."
1459+ "description": "The type of the Id."
1463+ "description": "The value of the id."
1470+ "description": "JSON template for instant messenger of an user.",
1472+ "customProtocol": {
1474+ "description": "Custom protocol."
1478+ "description": "Custom type."
1482+ "description": "Instant messenger id."
1486+ "description": "If this is user's primary im. Only one entry could be marked as primary."
1490+ "description": "Protocol used in the instant messenger. It should be one of the values from ImProtocolTypes map. Similar to type, it can take a CUSTOM value and specify the custom name in customProtocol field."
1494+ "description": "Each entry can have a type which indicates standard types of that entry. For example instant messengers could be of home, work etc. In addition to the standard type, an entry can have a custom type and can take any value. Such types should have the CUSTOM value as type and also have a customType value."
1499+ "id": "UserMakeAdmin",
1501+ "description": "JSON request template for setting/revoking admin status of a user in Directory API.",
1505+ "description": "Boolean indicating new admin status of the user",
1508+ "directory.users.makeAdmin"
1517+ "description": "JSON template for name of a user in Directory API.",
1521+ "description": "Last Name",
1524+ "directory.users.insert"
1530+ "description": "Full Name"
1534+ "description": "First Name",
1537+ "directory.users.insert"
1543+ "UserOrganization": {
1544+ "id": "UserOrganization",
1546+ "description": "JSON template for an organization entry.",
1550+ "description": "The cost center of the users department."
1554+ "description": "Custom type."
1558+ "description": "Department within the organization."
1562+ "description": "Description of the organization."
1566+ "description": "The domain to which the organization belongs to."
1570+ "description": "Location of the organization. This need not be fully qualified address."
1574+ "description": "Name of the organization"
1578+ "description": "If it user's primary organization."
1582+ "description": "Symbol of the organization."
1586+ "description": "Title (designation) of the user in the organization."
1590+ "description": "Each entry can have a type which indicates standard types of that entry. For example organization could be of school, work etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a CustomType value."
1597+ "description": "JSON template for a phone entry.",
1601+ "description": "Custom Type."
1605+ "description": "If this is user's primary phone or not."
1609+ "description": "Each entry can have a type which indicates standard types of that entry. For example phone could be of home_fax, work, mobile etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value."
1613+ "description": "Phone number."
1620+ "description": "JSON template for Photo object in Directory API.",
1624+ "description": "ETag of the resource."
1628+ "description": "Height in pixels of the photo",
1633+ "description": "Unique identifier of User (Read-only)"
1637+ "description": "Kind of resource this is.",
1638+ "default": "admin#directory#user#photo"
1642+ "description": "Mime Type of the photo"
1646+ "description": "Base64 encoded photo data",
1650+ "directory.users.photos.update"
1656+ "description": "Primary email of User (Read-only)"
1660+ "description": "Width in pixels of the photo",
1666+ "id": "UserRelation",
1668+ "description": "JSON template for a relation entry.",
1672+ "description": "Custom Type."
1676+ "description": "The relation of the user. Some of the possible values are mother, father, sister, brother, manager, assistant, partner."
1680+ "description": "The name of the relation."
1685+ "id": "UserUndelete",
1687+ "description": "JSON request template to undelete a user in Directory API.",
1691+ "description": "OrgUnit of User"
1696+ "id": "UserWebsite",
1698+ "description": "JSON template for a website entry.",
1702+ "description": "Custom Type."
1706+ "description": "If this is user's primary website or not."
1710+ "description": "Each entry can have a type which indicates standard types of that entry. For example website could be of home, work, blog etc. In addition to the standard type, an entry can have a custom type and can give it any name. Such types should have the CUSTOM value as type and also have a customType value."
1714+ "description": "Website."
1721+ "description": "JSON response template for List Users operation in Apps Directory API.",
1725+ "description": "ETag of the resource."
1729+ "description": "Kind of resource this is.",
1730+ "default": "admin#directory#users"
1734+ "description": "Token used to access next page of this result."
1738+ "description": "Event that triggered this response (only used in case of Push Response)"
1742+ "description": "List of user objects.",
1749+ "VerificationCode": {
1750+ "id": "VerificationCode",
1752+ "description": "JSON template for verification codes in Directory API.",
1756+ "description": "ETag of the resource."
1760+ "description": "The type of the resource. This is always admin#directory#verificationCode.",
1761+ "default": "admin#directory#verificationCode"
1765+ "description": "The obfuscated unique ID of the user."
1767+ "verificationCode": {
1769+ "description": "A current verification code for the user. Invalidated or used verification codes are not returned as part of the result."
1773+ "VerificationCodes": {
1774+ "id": "VerificationCodes",
1776+ "description": "JSON response template for List verification codes operation in Directory API.",
1780+ "description": "ETag of the resource."
1784+ "description": "A list of verification code resources.",
1786+ "$ref": "VerificationCode"
1791+ "description": "The type of the resource. This is always admin#directory#verificationCodesList.",
1792+ "default": "admin#directory#verificationCodesList"
1801+ "id": "directory.asps.delete",
1802+ "path": "users/{userKey}/asps/{codeId}",
1803+ "httpMethod": "DELETE",
1804+ "description": "Delete an ASP issued by a user.",
1808+ "description": "The unique ID of the ASP to be deleted.",
1815+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
1820+ "parameterOrder": [
1825+ "https://www.googleapis.com/auth/admin.directory.user.security"
1829+ "id": "directory.asps.get",
1830+ "path": "users/{userKey}/asps/{codeId}",
1831+ "httpMethod": "GET",
1832+ "description": "Get information about an ASP issued by a user.",
1836+ "description": "The unique ID of the ASP.",
1843+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
1848+ "parameterOrder": [
1856+ "https://www.googleapis.com/auth/admin.directory.user.security"
1860+ "id": "directory.asps.list",
1861+ "path": "users/{userKey}/asps",
1862+ "httpMethod": "GET",
1863+ "description": "List the ASPs issued by a user.",
1867+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
1872+ "parameterOrder": [
1879+ "https://www.googleapis.com/auth/admin.directory.user.security"
1887+ "id": "admin.channels.stop",
1888+ "path": "/admin/directory_v1/channels/stop",
1889+ "httpMethod": "POST",
1890+ "description": "Stop watching resources through this channel",
1893+ "parameterName": "resource"
1896+ "https://www.googleapis.com/auth/admin.directory.user",
1897+ "https://www.googleapis.com/auth/admin.directory.user.alias",
1898+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
1899+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
1904+ "chromeosdevices": {
1907+ "id": "directory.chromeosdevices.get",
1908+ "path": "customer/{customerId}/devices/chromeos/{deviceId}",
1909+ "httpMethod": "GET",
1910+ "description": "Retrieve Chrome OS Device",
1914+ "description": "Immutable id of the Google Apps account",
1920+ "description": "Immutable id of Chrome OS Device",
1926+ "description": "Restrict information returned to a set of selected fields.",
1931+ "enumDescriptions": [
1932+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
1933+ "Includes all metadata fields"
1935+ "location": "query"
1938+ "parameterOrder": [
1943+ "$ref": "ChromeOsDevice"
1946+ "https://www.googleapis.com/auth/admin.directory.device.chromeos",
1947+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
1951+ "id": "directory.chromeosdevices.list",
1952+ "path": "customer/{customerId}/devices/chromeos",
1953+ "httpMethod": "GET",
1954+ "description": "Retrieve all Chrome OS Devices of a customer (paginated)",
1958+ "description": "Immutable id of the Google Apps account",
1964+ "description": "Maximum number of results to return. Default is 100",
1967+ "location": "query"
1971+ "description": "Column to use for sorting results",
1973+ "annotatedLocation",
1981+ "enumDescriptions": [
1982+ "Chromebook location as annotated by the administrator.",
1983+ "Chromebook user as annotated by administrator.",
1984+ "Chromebook last sync.",
1985+ "Chromebook notes as annotated by the administrator.",
1986+ "Chromebook Serial Number.",
1987+ "Chromebook status.",
1988+ "Chromebook support end date."
1990+ "location": "query"
1994+ "description": "Token to specify next page in the list",
1995+ "location": "query"
1999+ "description": "Restrict information returned to a set of selected fields.",
2004+ "enumDescriptions": [
2005+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
2006+ "Includes all metadata fields"
2008+ "location": "query"
2012+ "description": "Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?hl=en&answer=1698333",
2013+ "location": "query"
2017+ "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
2022+ "enumDescriptions": [
2023+ "Ascending order.",
2024+ "Descending order."
2026+ "location": "query"
2029+ "parameterOrder": [
2033+ "$ref": "ChromeOsDevices"
2036+ "https://www.googleapis.com/auth/admin.directory.device.chromeos",
2037+ "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly"
2041+ "id": "directory.chromeosdevices.patch",
2042+ "path": "customer/{customerId}/devices/chromeos/{deviceId}",
2043+ "httpMethod": "PATCH",
2044+ "description": "Update Chrome OS Device. This method supports patch semantics.",
2048+ "description": "Immutable id of the Google Apps account",
2054+ "description": "Immutable id of Chrome OS Device",
2060+ "description": "Restrict information returned to a set of selected fields.",
2065+ "enumDescriptions": [
2066+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
2067+ "Includes all metadata fields"
2069+ "location": "query"
2072+ "parameterOrder": [
2077+ "$ref": "ChromeOsDevice"
2080+ "$ref": "ChromeOsDevice"
2083+ "https://www.googleapis.com/auth/admin.directory.device.chromeos"
2087+ "id": "directory.chromeosdevices.update",
2088+ "path": "customer/{customerId}/devices/chromeos/{deviceId}",
2089+ "httpMethod": "PUT",
2090+ "description": "Update Chrome OS Device",
2094+ "description": "Immutable id of the Google Apps account",
2100+ "description": "Immutable id of Chrome OS Device",
2106+ "description": "Restrict information returned to a set of selected fields.",
2111+ "enumDescriptions": [
2112+ "Includes only the basic metadata fields (e.g., deviceId, serialNumber, status, and user)",
2113+ "Includes all metadata fields"
2115+ "location": "query"
2118+ "parameterOrder": [
2123+ "$ref": "ChromeOsDevice"
2126+ "$ref": "ChromeOsDevice"
2129+ "https://www.googleapis.com/auth/admin.directory.device.chromeos"
2137+ "id": "directory.groups.delete",
2138+ "path": "groups/{groupKey}",
2139+ "httpMethod": "DELETE",
2140+ "description": "Delete Group",
2144+ "description": "Email or immutable Id of the group",
2149+ "parameterOrder": [
2153+ "https://www.googleapis.com/auth/admin.directory.group"
2157+ "id": "directory.groups.get",
2158+ "path": "groups/{groupKey}",
2159+ "httpMethod": "GET",
2160+ "description": "Retrieve Group",
2164+ "description": "Email or immutable Id of the group",
2169+ "parameterOrder": [
2176+ "https://www.googleapis.com/auth/admin.directory.group",
2177+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
2181+ "id": "directory.groups.insert",
2183+ "httpMethod": "POST",
2184+ "description": "Create Group",
2192+ "https://www.googleapis.com/auth/admin.directory.group"
2196+ "id": "directory.groups.list",
2198+ "httpMethod": "GET",
2199+ "description": "Retrieve all groups in a domain (paginated)",
2203+ "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.",
2204+ "location": "query"
2208+ "description": "Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.",
2209+ "location": "query"
2213+ "description": "Maximum number of results to return. Default is 200",
2216+ "location": "query"
2220+ "description": "Token to specify next page in the list",
2221+ "location": "query"
2225+ "description": "Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object",
2226+ "location": "query"
2233+ "https://www.googleapis.com/auth/admin.directory.group",
2234+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
2238+ "id": "directory.groups.patch",
2239+ "path": "groups/{groupKey}",
2240+ "httpMethod": "PATCH",
2241+ "description": "Update Group. This method supports patch semantics.",
2245+ "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
2250+ "parameterOrder": [
2260+ "https://www.googleapis.com/auth/admin.directory.group"
2264+ "id": "directory.groups.update",
2265+ "path": "groups/{groupKey}",
2266+ "httpMethod": "PUT",
2267+ "description": "Update Group",
2271+ "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
2276+ "parameterOrder": [
2286+ "https://www.googleapis.com/auth/admin.directory.group"
2294+ "id": "directory.groups.aliases.delete",
2295+ "path": "groups/{groupKey}/aliases/{alias}",
2296+ "httpMethod": "DELETE",
2297+ "description": "Remove a alias for the group",
2301+ "description": "The alias to be removed",
2307+ "description": "Email or immutable Id of the group",
2312+ "parameterOrder": [
2317+ "https://www.googleapis.com/auth/admin.directory.group"
2321+ "id": "directory.groups.aliases.insert",
2322+ "path": "groups/{groupKey}/aliases",
2323+ "httpMethod": "POST",
2324+ "description": "Add a alias for the group",
2328+ "description": "Email or immutable Id of the group",
2333+ "parameterOrder": [
2343+ "https://www.googleapis.com/auth/admin.directory.group"
2347+ "id": "directory.groups.aliases.list",
2348+ "path": "groups/{groupKey}/aliases",
2349+ "httpMethod": "GET",
2350+ "description": "List all aliases for a group",
2354+ "description": "Email or immutable Id of the group",
2359+ "parameterOrder": [
2366+ "https://www.googleapis.com/auth/admin.directory.group",
2367+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
2369+ "supportsSubscription": true
2378+ "id": "directory.members.delete",
2379+ "path": "groups/{groupKey}/members/{memberKey}",
2380+ "httpMethod": "DELETE",
2381+ "description": "Remove membership.",
2385+ "description": "Email or immutable Id of the group",
2391+ "description": "Email or immutable Id of the member",
2396+ "parameterOrder": [
2401+ "https://www.googleapis.com/auth/admin.directory.group",
2402+ "https://www.googleapis.com/auth/admin.directory.group.member"
2406+ "id": "directory.members.get",
2407+ "path": "groups/{groupKey}/members/{memberKey}",
2408+ "httpMethod": "GET",
2409+ "description": "Retrieve Group Member",
2413+ "description": "Email or immutable Id of the group",
2419+ "description": "Email or immutable Id of the member",
2424+ "parameterOrder": [
2432+ "https://www.googleapis.com/auth/admin.directory.group",
2433+ "https://www.googleapis.com/auth/admin.directory.group.member",
2434+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
2435+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
2439+ "id": "directory.members.insert",
2440+ "path": "groups/{groupKey}/members",
2441+ "httpMethod": "POST",
2442+ "description": "Add user to the specified group.",
2446+ "description": "Email or immutable Id of the group",
2451+ "parameterOrder": [
2461+ "https://www.googleapis.com/auth/admin.directory.group",
2462+ "https://www.googleapis.com/auth/admin.directory.group.member"
2466+ "id": "directory.members.list",
2467+ "path": "groups/{groupKey}/members",
2468+ "httpMethod": "GET",
2469+ "description": "Retrieve all members in a group (paginated)",
2473+ "description": "Email or immutable Id of the group",
2479+ "description": "Maximum number of results to return. Default is 200",
2482+ "location": "query"
2486+ "description": "Token to specify next page in the list",
2487+ "location": "query"
2491+ "description": "Comma separated role values to filter list results on.",
2492+ "location": "query"
2495+ "parameterOrder": [
2502+ "https://www.googleapis.com/auth/admin.directory.group",
2503+ "https://www.googleapis.com/auth/admin.directory.group.member",
2504+ "https://www.googleapis.com/auth/admin.directory.group.member.readonly",
2505+ "https://www.googleapis.com/auth/admin.directory.group.readonly"
2509+ "id": "directory.members.patch",
2510+ "path": "groups/{groupKey}/members/{memberKey}",
2511+ "httpMethod": "PATCH",
2512+ "description": "Update membership of a user in the specified group. This method supports patch semantics.",
2516+ "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
2522+ "description": "Email or immutable Id of the user. If Id, it should match with id of member object",
2527+ "parameterOrder": [
2538+ "https://www.googleapis.com/auth/admin.directory.group",
2539+ "https://www.googleapis.com/auth/admin.directory.group.member"
2543+ "id": "directory.members.update",
2544+ "path": "groups/{groupKey}/members/{memberKey}",
2545+ "httpMethod": "PUT",
2546+ "description": "Update membership of a user in the specified group.",
2550+ "description": "Email or immutable Id of the group. If Id, it should match with id of group object",
2556+ "description": "Email or immutable Id of the user. If Id, it should match with id of member object",
2561+ "parameterOrder": [
2572+ "https://www.googleapis.com/auth/admin.directory.group",
2573+ "https://www.googleapis.com/auth/admin.directory.group.member"
2581+ "id": "directory.mobiledevices.action",
2582+ "path": "customer/{customerId}/devices/mobile/{resourceId}/action",
2583+ "httpMethod": "POST",
2584+ "description": "Take action on Mobile Device",
2588+ "description": "Immutable id of the Google Apps account",
2594+ "description": "Immutable id of Mobile Device",
2599+ "parameterOrder": [
2604+ "$ref": "MobileDeviceAction"
2607+ "https://www.googleapis.com/auth/admin.directory.device.mobile",
2608+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action"
2612+ "id": "directory.mobiledevices.delete",
2613+ "path": "customer/{customerId}/devices/mobile/{resourceId}",
2614+ "httpMethod": "DELETE",
2615+ "description": "Delete Mobile Device",
2619+ "description": "Immutable id of the Google Apps account",
2625+ "description": "Immutable id of Mobile Device",
2630+ "parameterOrder": [
2635+ "https://www.googleapis.com/auth/admin.directory.device.mobile"
2639+ "id": "directory.mobiledevices.get",
2640+ "path": "customer/{customerId}/devices/mobile/{resourceId}",
2641+ "httpMethod": "GET",
2642+ "description": "Retrieve Mobile Device",
2646+ "description": "Immutable id of the Google Apps account",
2652+ "description": "Restrict information returned to a set of selected fields.",
2657+ "enumDescriptions": [
2658+ "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
2659+ "Includes all metadata fields"
2661+ "location": "query"
2665+ "description": "Immutable id of Mobile Device",
2670+ "parameterOrder": [
2675+ "$ref": "MobileDevice"
2678+ "https://www.googleapis.com/auth/admin.directory.device.mobile",
2679+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
2680+ "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
2684+ "id": "directory.mobiledevices.list",
2685+ "path": "customer/{customerId}/devices/mobile",
2686+ "httpMethod": "GET",
2687+ "description": "Retrieve all Mobile Devices of a customer (paginated)",
2691+ "description": "Immutable id of the Google Apps account",
2697+ "description": "Maximum number of results to return. Default is 100",
2700+ "location": "query"
2704+ "description": "Column to use for sorting results",
2715+ "enumDescriptions": [
2716+ "Mobile Device serial number.",
2717+ "Owner user email.",
2718+ "Last policy settings sync date time of the device.",
2719+ "Mobile Device model.",
2720+ "Owner user name.",
2721+ "Mobile operating system.",
2722+ "Status of the device.",
2723+ "Type of the device."
2725+ "location": "query"
2729+ "description": "Token to specify next page in the list",
2730+ "location": "query"
2734+ "description": "Restrict information returned to a set of selected fields.",
2739+ "enumDescriptions": [
2740+ "Includes only the basic metadata fields (e.g., deviceId, model, status, type, and status)",
2741+ "Includes all metadata fields"
2743+ "location": "query"
2747+ "description": "Search string in the format given at http://support.google.com/a/bin/answer.py?hl=en&answer=1408863#search",
2748+ "location": "query"
2752+ "description": "Whether to return results in ascending or descending order. Only of use when orderBy is also used",
2757+ "enumDescriptions": [
2758+ "Ascending order.",
2759+ "Descending order."
2761+ "location": "query"
2764+ "parameterOrder": [
2768+ "$ref": "MobileDevices"
2771+ "https://www.googleapis.com/auth/admin.directory.device.mobile",
2772+ "https://www.googleapis.com/auth/admin.directory.device.mobile.action",
2773+ "https://www.googleapis.com/auth/admin.directory.device.mobile.readonly"
2781+ "id": "directory.notifications.delete",
2782+ "path": "customer/{customer}/notifications/{notificationId}",
2783+ "httpMethod": "DELETE",
2784+ "description": "Deletes a notification",
2788+ "description": "The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.",
2792+ "notificationId": {
2794+ "description": "The unique ID of the notification.",
2799+ "parameterOrder": [
2804+ "https://www.googleapis.com/auth/admin.directory.notifications"
2808+ "id": "directory.notifications.get",
2809+ "path": "customer/{customer}/notifications/{notificationId}",
2810+ "httpMethod": "GET",
2811+ "description": "Retrieves a notification.",
2815+ "description": "The unique ID for the customer's Google account. The customerId is also returned as part of the Users resource.",
2819+ "notificationId": {
2821+ "description": "The unique ID of the notification.",
2826+ "parameterOrder": [
2831+ "$ref": "Notification"
2834+ "https://www.googleapis.com/auth/admin.directory.notifications"
2838+ "id": "directory.notifications.list",
2839+ "path": "customer/{customer}/notifications",
2840+ "httpMethod": "GET",
2841+ "description": "Retrieves a list of notifications.",
2845+ "description": "The unique ID for the customer's Google account.",
2851+ "description": "The ISO 639-1 code of the language notifications are returned in. The default is English (en).",
2852+ "location": "query"
2856+ "description": "Maximum number of notifications to return per page. The default is 100.",
2857+ "format": "uint32",
2858+ "location": "query"
2862+ "description": "The token to specify the page of results to retrieve.",
2863+ "location": "query"
2866+ "parameterOrder": [
2870+ "$ref": "Notifications"
2873+ "https://www.googleapis.com/auth/admin.directory.notifications"
2877+ "id": "directory.notifications.patch",
2878+ "path": "customer/{customer}/notifications/{notificationId}",
2879+ "httpMethod": "PATCH",
2880+ "description": "Updates a notification. This method supports patch semantics.",
2884+ "description": "The unique ID for the customer's Google account.",
2888+ "notificationId": {
2890+ "description": "The unique ID of the notification.",
2895+ "parameterOrder": [
2900+ "$ref": "Notification"
2903+ "$ref": "Notification"
2906+ "https://www.googleapis.com/auth/admin.directory.notifications"
2910+ "id": "directory.notifications.update",
2911+ "path": "customer/{customer}/notifications/{notificationId}",
2912+ "httpMethod": "PUT",
2913+ "description": "Updates a notification.",
2917+ "description": "The unique ID for the customer's Google account.",
2921+ "notificationId": {
2923+ "description": "The unique ID of the notification.",
2928+ "parameterOrder": [
2933+ "$ref": "Notification"
2936+ "$ref": "Notification"
2939+ "https://www.googleapis.com/auth/admin.directory.notifications"
2947+ "id": "directory.orgunits.delete",
2948+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
2949+ "httpMethod": "DELETE",
2950+ "description": "Remove Organization Unit",
2954+ "description": "Immutable id of the Google Apps account",
2960+ "description": "Full path of the organization unit or its Id",
2966+ "parameterOrder": [
2971+ "https://www.googleapis.com/auth/admin.directory.orgunit"
2975+ "id": "directory.orgunits.get",
2976+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
2977+ "httpMethod": "GET",
2978+ "description": "Retrieve Organization Unit",
2982+ "description": "Immutable id of the Google Apps account",
2988+ "description": "Full path of the organization unit or its Id",
2994+ "parameterOrder": [
3002+ "https://www.googleapis.com/auth/admin.directory.orgunit",
3003+ "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
3007+ "id": "directory.orgunits.insert",
3008+ "path": "customer/{customerId}/orgunits",
3009+ "httpMethod": "POST",
3010+ "description": "Add Organization Unit",
3014+ "description": "Immutable id of the Google Apps account",
3019+ "parameterOrder": [
3029+ "https://www.googleapis.com/auth/admin.directory.orgunit"
3033+ "id": "directory.orgunits.list",
3034+ "path": "customer/{customerId}/orgunits",
3035+ "httpMethod": "GET",
3036+ "description": "Retrieve all Organization Units",
3040+ "description": "Immutable id of the Google Apps account",
3046+ "description": "the URL-encoded organization unit's path or its Id",
3048+ "location": "query"
3052+ "description": "Whether to return all sub-organizations or just immediate children",
3057+ "enumDescriptions": [
3058+ "All sub-organization units.",
3059+ "Immediate children only (default)."
3061+ "location": "query"
3064+ "parameterOrder": [
3071+ "https://www.googleapis.com/auth/admin.directory.orgunit",
3072+ "https://www.googleapis.com/auth/admin.directory.orgunit.readonly"
3076+ "id": "directory.orgunits.patch",
3077+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
3078+ "httpMethod": "PATCH",
3079+ "description": "Update Organization Unit. This method supports patch semantics.",
3083+ "description": "Immutable id of the Google Apps account",
3089+ "description": "Full path of the organization unit or its Id",
3095+ "parameterOrder": [
3106+ "https://www.googleapis.com/auth/admin.directory.orgunit"
3110+ "id": "directory.orgunits.update",
3111+ "path": "customer/{customerId}/orgunits{/orgUnitPath*}",
3112+ "httpMethod": "PUT",
3113+ "description": "Update Organization Unit",
3117+ "description": "Immutable id of the Google Apps account",
3123+ "description": "Full path of the organization unit or its Id",
3129+ "parameterOrder": [
3140+ "https://www.googleapis.com/auth/admin.directory.orgunit"
3148+ "id": "directory.schemas.delete",
3149+ "path": "customer/{customerId}/schemas/{schemaKey}",
3150+ "httpMethod": "DELETE",
3151+ "description": "Delete schema",
3155+ "description": "Immutable id of the Google Apps account",
3161+ "description": "Name or immutable Id of the schema",
3166+ "parameterOrder": [
3171+ "https://www.googleapis.com/auth/admin.directory.userschema"
3175+ "id": "directory.schemas.get",
3176+ "path": "customer/{customerId}/schemas/{schemaKey}",
3177+ "httpMethod": "GET",
3178+ "description": "Retrieve schema",
3182+ "description": "Immutable id of the Google Apps account",
3188+ "description": "Name or immutable Id of the schema",
3193+ "parameterOrder": [
3201+ "https://www.googleapis.com/auth/admin.directory.userschema",
3202+ "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
3206+ "id": "directory.schemas.insert",
3207+ "path": "customer/{customerId}/schemas",
3208+ "httpMethod": "POST",
3209+ "description": "Create schema.",
3213+ "description": "Immutable id of the Google Apps account",
3218+ "parameterOrder": [
3228+ "https://www.googleapis.com/auth/admin.directory.userschema"
3232+ "id": "directory.schemas.list",
3233+ "path": "customer/{customerId}/schemas",
3234+ "httpMethod": "GET",
3235+ "description": "Retrieve all schemas for a customer",
3239+ "description": "Immutable id of the Google Apps account",
3244+ "parameterOrder": [
3251+ "https://www.googleapis.com/auth/admin.directory.userschema",
3252+ "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
3256+ "id": "directory.schemas.patch",
3257+ "path": "customer/{customerId}/schemas/{schemaKey}",
3258+ "httpMethod": "PATCH",
3259+ "description": "Update schema. This method supports patch semantics.",
3263+ "description": "Immutable id of the Google Apps account",
3269+ "description": "Name or immutable Id of the schema.",
3274+ "parameterOrder": [
3285+ "https://www.googleapis.com/auth/admin.directory.userschema"
3289+ "id": "directory.schemas.update",
3290+ "path": "customer/{customerId}/schemas/{schemaKey}",
3291+ "httpMethod": "PUT",
3292+ "description": "Update schema",
3296+ "description": "Immutable id of the Google Apps account",
3302+ "description": "Name or immutable Id of the schema.",
3307+ "parameterOrder": [
3318+ "https://www.googleapis.com/auth/admin.directory.userschema"
3326+ "id": "directory.tokens.delete",
3327+ "path": "users/{userKey}/tokens/{clientId}",
3328+ "httpMethod": "DELETE",
3329+ "description": "Delete all access tokens issued by a user for an application.",
3333+ "description": "The Client ID of the application the token is issued to.",
3339+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
3344+ "parameterOrder": [
3349+ "https://www.googleapis.com/auth/admin.directory.user.security"
3353+ "id": "directory.tokens.get",
3354+ "path": "users/{userKey}/tokens/{clientId}",
3355+ "httpMethod": "GET",
3356+ "description": "Get information about an access token issued by a user.",
3360+ "description": "The Client ID of the application the token is issued to.",
3366+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
3371+ "parameterOrder": [
3379+ "https://www.googleapis.com/auth/admin.directory.user.security"
3383+ "id": "directory.tokens.list",
3384+ "path": "users/{userKey}/tokens",
3385+ "httpMethod": "GET",
3386+ "description": "Returns the set of tokens specified user has issued to 3rd party applications.",
3390+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
3395+ "parameterOrder": [
3402+ "https://www.googleapis.com/auth/admin.directory.user.security"
3410+ "id": "directory.users.delete",
3411+ "path": "users/{userKey}",
3412+ "httpMethod": "DELETE",
3413+ "description": "Delete user",
3417+ "description": "Email or immutable Id of the user",
3422+ "parameterOrder": [
3426+ "https://www.googleapis.com/auth/admin.directory.user"
3430+ "id": "directory.users.get",
3431+ "path": "users/{userKey}",
3432+ "httpMethod": "GET",
3433+ "description": "retrieve user",
3435+ "customFieldMask": {
3437+ "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
3438+ "location": "query"
3442+ "description": "What subset of fields to fetch for this user.",
3443+ "default": "basic",
3449+ "enumDescriptions": [
3450+ "Do not include any custom fields for the user.",
3451+ "Include custom fields from schemas mentioned in customFieldMask.",
3452+ "Include all fields associated with this user."
3454+ "location": "query"
3458+ "description": "Email or immutable Id of the user",
3464+ "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
3465+ "default": "admin_view",
3470+ "enumDescriptions": [
3471+ "Fetches the ADMIN_VIEW of the user.",
3472+ "Fetches the DOMAIN_PUBLIC view of the user."
3474+ "location": "query"
3477+ "parameterOrder": [
3484+ "https://www.googleapis.com/auth/admin.directory.user",
3485+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
3489+ "id": "directory.users.insert",
3491+ "httpMethod": "POST",
3492+ "description": "create user.",
3500+ "https://www.googleapis.com/auth/admin.directory.user"
3504+ "id": "directory.users.list",
3506+ "httpMethod": "GET",
3507+ "description": "Retrieve either deleted users or all users in a domain (paginated)",
3509+ "customFieldMask": {
3511+ "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
3512+ "location": "query"
3516+ "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.",
3517+ "location": "query"
3521+ "description": "Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.",
3522+ "location": "query"
3526+ "description": "Event on which subscription is intended (if subscribing)",
3534+ "enumDescriptions": [
3535+ "User Created Event",
3536+ "User Deleted Event",
3537+ "User Admin Status Change Event",
3538+ "User Undeleted Event",
3539+ "User Updated Event"
3541+ "location": "query"
3545+ "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
3549+ "location": "query"
3553+ "description": "Column to use for sorting results",
3559+ "enumDescriptions": [
3560+ "Primary email of the user.",
3561+ "User's family name.",
3562+ "User's given name."
3564+ "location": "query"
3568+ "description": "Token to specify next page in the list",
3569+ "location": "query"
3573+ "description": "What subset of fields to fetch for this user.",
3574+ "default": "basic",
3580+ "enumDescriptions": [
3581+ "Do not include any custom fields for the user.",
3582+ "Include custom fields from schemas mentioned in customFieldMask.",
3583+ "Include all fields associated with this user."
3585+ "location": "query"
3589+ "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
3590+ "location": "query"
3594+ "description": "If set to true retrieves the list of deleted users. Default is false",
3595+ "location": "query"
3599+ "description": "Whether to return results in ascending or descending order.",
3604+ "enumDescriptions": [
3605+ "Ascending order.",
3606+ "Descending order."
3608+ "location": "query"
3612+ "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
3613+ "default": "admin_view",
3618+ "enumDescriptions": [
3619+ "Fetches the ADMIN_VIEW of the user.",
3620+ "Fetches the DOMAIN_PUBLIC view of the user."
3622+ "location": "query"
3629+ "https://www.googleapis.com/auth/admin.directory.user",
3630+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
3632+ "supportsSubscription": true
3635+ "id": "directory.users.makeAdmin",
3636+ "path": "users/{userKey}/makeAdmin",
3637+ "httpMethod": "POST",
3638+ "description": "change admin status of a user",
3642+ "description": "Email or immutable Id of the user as admin",
3647+ "parameterOrder": [
3651+ "$ref": "UserMakeAdmin"
3654+ "https://www.googleapis.com/auth/admin.directory.user"
3658+ "id": "directory.users.patch",
3659+ "path": "users/{userKey}",
3660+ "httpMethod": "PATCH",
3661+ "description": "update user. This method supports patch semantics.",
3665+ "description": "Email or immutable Id of the user. If Id, it should match with id of user object",
3670+ "parameterOrder": [
3680+ "https://www.googleapis.com/auth/admin.directory.user"
3684+ "id": "directory.users.undelete",
3685+ "path": "users/{userKey}/undelete",
3686+ "httpMethod": "POST",
3687+ "description": "Undelete a deleted user",
3691+ "description": "The immutable id of the user",
3696+ "parameterOrder": [
3700+ "$ref": "UserUndelete"
3703+ "https://www.googleapis.com/auth/admin.directory.user"
3707+ "id": "directory.users.update",
3708+ "path": "users/{userKey}",
3709+ "httpMethod": "PUT",
3710+ "description": "update user",
3714+ "description": "Email or immutable Id of the user. If Id, it should match with id of user object",
3719+ "parameterOrder": [
3729+ "https://www.googleapis.com/auth/admin.directory.user"
3733+ "id": "directory.users.watch",
3734+ "path": "users/watch",
3735+ "httpMethod": "POST",
3736+ "description": "Watch for changes in users list",
3738+ "customFieldMask": {
3740+ "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
3741+ "location": "query"
3745+ "description": "Immutable id of the Google Apps account. In case of multi-domain, to fetch all users for a customer, fill this field instead of domain.",
3746+ "location": "query"
3750+ "description": "Name of the domain. Fill this field to get users from only this domain. To return all users in a multi-domain fill customer field instead.",
3751+ "location": "query"
3755+ "description": "Event on which subscription is intended (if subscribing)",
3763+ "enumDescriptions": [
3764+ "User Created Event",
3765+ "User Deleted Event",
3766+ "User Admin Status Change Event",
3767+ "User Undeleted Event",
3768+ "User Updated Event"
3770+ "location": "query"
3774+ "description": "Maximum number of results to return. Default is 100. Max allowed is 500",
3778+ "location": "query"
3782+ "description": "Column to use for sorting results",
3788+ "enumDescriptions": [
3789+ "Primary email of the user.",
3790+ "User's family name.",
3791+ "User's given name."
3793+ "location": "query"
3797+ "description": "Token to specify next page in the list",
3798+ "location": "query"
3802+ "description": "What subset of fields to fetch for this user.",
3803+ "default": "basic",
3809+ "enumDescriptions": [
3810+ "Do not include any custom fields for the user.",
3811+ "Include custom fields from schemas mentioned in customFieldMask.",
3812+ "Include all fields associated with this user."
3814+ "location": "query"
3818+ "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
3819+ "location": "query"
3823+ "description": "If set to true retrieves the list of deleted users. Default is false",
3824+ "location": "query"
3828+ "description": "Whether to return results in ascending or descending order.",
3833+ "enumDescriptions": [
3834+ "Ascending order.",
3835+ "Descending order."
3837+ "location": "query"
3841+ "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
3842+ "default": "admin_view",
3847+ "enumDescriptions": [
3848+ "Fetches the ADMIN_VIEW of the user.",
3849+ "Fetches the DOMAIN_PUBLIC view of the user."
3851+ "location": "query"
3856+ "parameterName": "resource"
3862+ "https://www.googleapis.com/auth/admin.directory.user",
3863+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
3865+ "supportsSubscription": true
3872+ "id": "directory.users.aliases.delete",
3873+ "path": "users/{userKey}/aliases/{alias}",
3874+ "httpMethod": "DELETE",
3875+ "description": "Remove a alias for the user",
3879+ "description": "The alias to be removed",
3885+ "description": "Email or immutable Id of the user",
3890+ "parameterOrder": [
3895+ "https://www.googleapis.com/auth/admin.directory.user",
3896+ "https://www.googleapis.com/auth/admin.directory.user.alias"
3900+ "id": "directory.users.aliases.insert",
3901+ "path": "users/{userKey}/aliases",
3902+ "httpMethod": "POST",
3903+ "description": "Add a alias for the user",
3907+ "description": "Email or immutable Id of the user",
3912+ "parameterOrder": [
3922+ "https://www.googleapis.com/auth/admin.directory.user",
3923+ "https://www.googleapis.com/auth/admin.directory.user.alias"
3927+ "id": "directory.users.aliases.list",
3928+ "path": "users/{userKey}/aliases",
3929+ "httpMethod": "GET",
3930+ "description": "List all aliases for a user",
3934+ "description": "Event on which subscription is intended (if subscribing)",
3939+ "enumDescriptions": [
3940+ "Alias Created Event",
3941+ "Alias Deleted Event"
3943+ "location": "query"
3947+ "description": "Email or immutable Id of the user",
3952+ "parameterOrder": [
3959+ "https://www.googleapis.com/auth/admin.directory.user",
3960+ "https://www.googleapis.com/auth/admin.directory.user.alias",
3961+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
3962+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
3964+ "supportsSubscription": true
3967+ "id": "directory.users.aliases.watch",
3968+ "path": "users/{userKey}/aliases/watch",
3969+ "httpMethod": "POST",
3970+ "description": "Watch for changes in user aliases list",
3974+ "description": "Event on which subscription is intended (if subscribing)",
3979+ "enumDescriptions": [
3980+ "Alias Created Event",
3981+ "Alias Deleted Event"
3983+ "location": "query"
3987+ "description": "Email or immutable Id of the user",
3992+ "parameterOrder": [
3997+ "parameterName": "resource"
4003+ "https://www.googleapis.com/auth/admin.directory.user",
4004+ "https://www.googleapis.com/auth/admin.directory.user.alias",
4005+ "https://www.googleapis.com/auth/admin.directory.user.alias.readonly",
4006+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
4008+ "supportsSubscription": true
4015+ "id": "directory.users.photos.delete",
4016+ "path": "users/{userKey}/photos/thumbnail",
4017+ "httpMethod": "DELETE",
4018+ "description": "Remove photos for the user",
4022+ "description": "Email or immutable Id of the user",
4027+ "parameterOrder": [
4031+ "https://www.googleapis.com/auth/admin.directory.user"
4035+ "id": "directory.users.photos.get",
4036+ "path": "users/{userKey}/photos/thumbnail",
4037+ "httpMethod": "GET",
4038+ "description": "Retrieve photo of a user",
4042+ "description": "Email or immutable Id of the user",
4047+ "parameterOrder": [
4051+ "$ref": "UserPhoto"
4054+ "https://www.googleapis.com/auth/admin.directory.user",
4055+ "https://www.googleapis.com/auth/admin.directory.user.readonly"
4059+ "id": "directory.users.photos.patch",
4060+ "path": "users/{userKey}/photos/thumbnail",
4061+ "httpMethod": "PATCH",
4062+ "description": "Add a photo for the user. This method supports patch semantics.",
4066+ "description": "Email or immutable Id of the user",
4071+ "parameterOrder": [
4075+ "$ref": "UserPhoto"
4078+ "$ref": "UserPhoto"
4081+ "https://www.googleapis.com/auth/admin.directory.user"
4085+ "id": "directory.users.photos.update",
4086+ "path": "users/{userKey}/photos/thumbnail",
4087+ "httpMethod": "PUT",
4088+ "description": "Add a photo for the user",
4092+ "description": "Email or immutable Id of the user",
4097+ "parameterOrder": [
4101+ "$ref": "UserPhoto"
4104+ "$ref": "UserPhoto"
4107+ "https://www.googleapis.com/auth/admin.directory.user"
4114+ "verificationCodes": {
4117+ "id": "directory.verificationCodes.generate",
4118+ "path": "users/{userKey}/verificationCodes/generate",
4119+ "httpMethod": "POST",
4120+ "description": "Generate new backup verification codes for the user.",
4124+ "description": "Email or immutable Id of the user",
4129+ "parameterOrder": [
4133+ "https://www.googleapis.com/auth/admin.directory.user.security"
4137+ "id": "directory.verificationCodes.invalidate",
4138+ "path": "users/{userKey}/verificationCodes/invalidate",
4139+ "httpMethod": "POST",
4140+ "description": "Invalidate the current backup verification codes for the user.",
4144+ "description": "Email or immutable Id of the user",
4149+ "parameterOrder": [
4153+ "https://www.googleapis.com/auth/admin.directory.user.security"
4157+ "id": "directory.verificationCodes.list",
4158+ "path": "users/{userKey}/verificationCodes",
4159+ "httpMethod": "GET",
4160+ "description": "Returns the current set of valid backup verification codes for the specified user.",
4164+ "description": "Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.",
4169+ "parameterOrder": [
4173+ "$ref": "VerificationCodes"
4176+ "https://www.googleapis.com/auth/admin.directory.user.security"