Api roll 1: 2014-09-23

discovery/googleapis/admin__directory_v1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/admin.directory.device.chromeos": {
                     "description": "View and manage your Chrome OS devices' metadata"
                 },
                 "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": {
                     "description": "View your Chrome OS devices' metadata"
                 },
@@ skipping 34 matching lines @@
                     "description": "View and manage user aliases on your domain"
                 },
                 "https://www.googleapis.com/auth/admin.directory.user.alias.readonly": {
                     "description": "View user aliases on your domain"
                 },
                 "https://www.googleapis.com/auth/admin.directory.user.readonly": {
                     "description": "View users on your domain"
                 },
                 "https://www.googleapis.com/auth/admin.directory.user.security": {
                     "description": "Manage data access permissions for users on your domain"
+                },
+                "https://www.googleapis.com/auth/admin.directory.userschema": {
+                    "description": "View and manage the provisioning of user schemas on your domain"
+                },
+                "https://www.googleapis.com/auth/admin.directory.userschema.readonly": {
+                    "description": "View user schemas on your domain"
                 }
             }
         }
     },
     "basePath": "/admin/directory/v1/",
     "baseUrl": "https://www.googleapis.com/admin/directory/v1/",
     "batchPath": "batch",
     "canonicalName": "directory",
     "description": "The Admin SDK Directory API lets you view and manage enterprise resources such as users and groups, administrative notifications, security features, and more.",
     "discoveryVersion": "v1",
     "documentationLink": "https://developers.google.com/admin-sdk/directory/",
-    "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/j_ZwE0C9AiYczX4hTNBHFJNHzq0\"",
+    "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/JayrKKEnIqmNj16l21fqKTyl5PU\"",
     "icons": {
         "x16": "http://www.google.com/images/icons/product/search-16.gif",
         "x32": "http://www.google.com/images/icons/product/search-32.gif"
     },
     "id": "admin:directory_v1",
     "kind": "discovery#restDescription",
     "name": "admin",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "packagePath": "admin",
@@ skipping 1384 matching lines @@
                     },
                     "response": {
                         "$ref": "OrgUnit"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/admin.directory.orgunit"
                     ]
                 }
             }
         },
+        "schemas": {
+            "methods": {
+                "delete": {
+                    "description": "Delete schema",
+                    "httpMethod": "DELETE",
+                    "id": "directory.schemas.delete",
+                    "parameterOrder": [
+                        "customerId",
+                        "schemaKey"
+                    ],
+                    "parameters": {
+                        "customerId": {
+                            "description": "Immutable id of the Google Apps account",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        },
+                        "schemaKey": {
+                            "description": "Name or immutable Id of the schema",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "customer/{customerId}/schemas/{schemaKey}",
+                    "scopes": [
+                        "https://www.googleapis.com/auth/admin.directory.userschema"
+                    ]
+                },
+                "get": {
+                    "description": "Retrieve schema",
+                    "httpMethod": "GET",
+                    "id": "directory.schemas.get",
+                    "parameterOrder": [
+                        "customerId",
+                        "schemaKey"
+                    ],
+                    "parameters": {
+                        "customerId": {
+                            "description": "Immutable id of the Google Apps account",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        },
+                        "schemaKey": {
+                            "description": "Name or immutable Id of the schema",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "customer/{customerId}/schemas/{schemaKey}",
+                    "response": {
+                        "$ref": "Schema"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/admin.directory.userschema",
+                        "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
+                    ]
+                },
+                "insert": {
+                    "description": "Create schema.",
+                    "httpMethod": "POST",
+                    "id": "directory.schemas.insert",
+                    "parameterOrder": [
+                        "customerId"
+                    ],
+                    "parameters": {
+                        "customerId": {
+                            "description": "Immutable id of the Google Apps account",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "customer/{customerId}/schemas",
+                    "request": {
+                        "$ref": "Schema"
+                    },
+                    "response": {
+                        "$ref": "Schema"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/admin.directory.userschema"
+                    ]
+                },
+                "list": {
+                    "description": "Retrieve all schemas for a customer",
+                    "httpMethod": "GET",
+                    "id": "directory.schemas.list",
+                    "parameterOrder": [
+                        "customerId"
+                    ],
+                    "parameters": {
+                        "customerId": {
+                            "description": "Immutable id of the Google Apps account",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "customer/{customerId}/schemas",
+                    "response": {
+                        "$ref": "Schemas"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/admin.directory.userschema",
+                        "https://www.googleapis.com/auth/admin.directory.userschema.readonly"
+                    ]
+                },
+                "patch": {
+                    "description": "Update schema. This method supports patch semantics.",
+                    "httpMethod": "PATCH",
+                    "id": "directory.schemas.patch",
+                    "parameterOrder": [
+                        "customerId",
+                        "schemaKey"
+                    ],
+                    "parameters": {
+                        "customerId": {
+                            "description": "Immutable id of the Google Apps account",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        },
+                        "schemaKey": {
+                            "description": "Name or immutable Id of the schema.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "customer/{customerId}/schemas/{schemaKey}",
+                    "request": {
+                        "$ref": "Schema"
+                    },
+                    "response": {
+                        "$ref": "Schema"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/admin.directory.userschema"
+                    ]
+                },
+                "update": {
+                    "description": "Update schema",
+                    "httpMethod": "PUT",
+                    "id": "directory.schemas.update",
+                    "parameterOrder": [
+                        "customerId",
+                        "schemaKey"
+                    ],
+                    "parameters": {
+                        "customerId": {
+                            "description": "Immutable id of the Google Apps account",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        },
+                        "schemaKey": {
+                            "description": "Name or immutable Id of the schema.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "customer/{customerId}/schemas/{schemaKey}",
+                    "request": {
+                        "$ref": "Schema"
+                    },
+                    "response": {
+                        "$ref": "Schema"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/admin.directory.userschema"
+                    ]
+                }
+            }
+        },
         "tokens": {
             "methods": {
                 "delete": {
                     "description": "Delete all access tokens issued by a user for an application.",
                     "httpMethod": "DELETE",
                     "id": "directory.tokens.delete",
                     "parameterOrder": [
                         "userKey",
                         "clientId"
                     ],
@@ skipping 94 matching lines @@
                     ]
                 },
                 "get": {
                     "description": "retrieve user",
                     "httpMethod": "GET",
                     "id": "directory.users.get",
                     "parameterOrder": [
                         "userKey"
                     ],
                     "parameters": {
+                        "customFieldMask": {
+                            "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
+                            "location": "query",
+                            "type": "string"
+                        },
+                        "projection": {
+                            "default": "basic",
+                            "description": "What subset of fields to fetch for this user.",
+                            "enum": [
+                                "basic",
+                                "custom",
+                                "full"
+                            ],
+                            "enumDescriptions": [
+                                "Do not include any custom fields for the user.",
+                                "Include custom fields from schemas mentioned in customFieldMask.",
+                                "Include all fields associated with this user."
+                            ],
+                            "location": "query",
+                            "type": "string"
+                        },
                         "userKey": {
                             "description": "Email or immutable Id of the user",
                             "location": "path",
                             "required": true,
                             "type": "string"
+                        },
+                        "viewType": {
+                            "default": "admin_view",
+                            "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
+                            "enum": [
+                                "admin_view",
+                                "domain_public"
+                            ],
+                            "enumDescriptions": [
+                                "Fetches the ADMIN_VIEW of the user.",
+                                "Fetches the DOMAIN_PUBLIC view of the user."
+                            ],
+                            "location": "query",
+                            "type": "string"
                         }
                     },
                     "path": "users/{userKey}",
                     "response": {
                         "$ref": "User"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/admin.directory.user",
                         "https://www.googleapis.com/auth/admin.directory.user.readonly"
                     ]
@@ skipping 11 matching lines @@
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/admin.directory.user"
                     ]
                 },
                 "list": {
                     "description": "Retrieve either deleted users or all users in a domain (paginated)",
                     "httpMethod": "GET",
                     "id": "directory.users.list",
                     "parameters": {
+                        "customFieldMask": {
+                            "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
+                            "location": "query",
+                            "type": "string"
+                        },
                         "customer": {
                             "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.",
                             "location": "query",
                             "type": "string"
                         },
                         "domain": {
                             "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.",
                             "location": "query",
                             "type": "string"
                         },
@@ skipping 37 matching lines @@
                                 "User's given name."
                             ],
                             "location": "query",
                             "type": "string"
                         },
                         "pageToken": {
                             "description": "Token to specify next page in the list",
                             "location": "query",
                             "type": "string"
                         },
+                        "projection": {
+                            "default": "basic",
+                            "description": "What subset of fields to fetch for this user.",
+                            "enum": [
+                                "basic",
+                                "custom",
+                                "full"
+                            ],
+                            "enumDescriptions": [
+                                "Do not include any custom fields for the user.",
+                                "Include custom fields from schemas mentioned in customFieldMask.",
+                                "Include all fields associated with this user."
+                            ],
+                            "location": "query",
+                            "type": "string"
+                        },
                         "query": {
-                            "description": "Query string search. Should be of the form \"\" where field can be any of supported fields, operators can be one of '=' for exact match or ':' for prefix match. For prefix match, the value should always be followed by a *.",
+                            "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
                             "location": "query",
                             "type": "string"
                         },
                         "showDeleted": {
                             "description": "If set to true retrieves the list of deleted users. Default is false",
                             "location": "query",
                             "type": "string"
                         },
                         "sortOrder": {
                             "description": "Whether to return results in ascending or descending order.",
                             "enum": [
                                 "ASCENDING",
                                 "DESCENDING"
                             ],
                             "enumDescriptions": [
                                 "Ascending order.",
                                 "Descending order."
                             ],
                             "location": "query",
                             "type": "string"
+                        },
+                        "viewType": {
+                            "default": "admin_view",
+                            "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
+                            "enum": [
+                                "admin_view",
+                                "domain_public"
+                            ],
+                            "enumDescriptions": [
+                                "Fetches the ADMIN_VIEW of the user.",
+                                "Fetches the DOMAIN_PUBLIC view of the user."
+                            ],
+                            "location": "query",
+                            "type": "string"
                         }
                     },
                     "path": "users",
                     "response": {
                         "$ref": "Users"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/admin.directory.user",
                         "https://www.googleapis.com/auth/admin.directory.user.readonly"
                     ],
@@ skipping 95 matching lines @@
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/admin.directory.user"
                     ]
                 },
                 "watch": {
                     "description": "Watch for changes in users list",
                     "httpMethod": "POST",
                     "id": "directory.users.watch",
                     "parameters": {
+                        "customFieldMask": {
+                            "description": "Comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.",
+                            "location": "query",
+                            "type": "string"
+                        },
                         "customer": {
                             "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.",
                             "location": "query",
                             "type": "string"
                         },
                         "domain": {
                             "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.",
                             "location": "query",
                             "type": "string"
                         },
@@ skipping 37 matching lines @@
                                 "User's given name."
                             ],
                             "location": "query",
                             "type": "string"
                         },
                         "pageToken": {
                             "description": "Token to specify next page in the list",
                             "location": "query",
                             "type": "string"
                         },
+                        "projection": {
+                            "default": "basic",
+                            "description": "What subset of fields to fetch for this user.",
+                            "enum": [
+                                "basic",
+                                "custom",
+                                "full"
+                            ],
+                            "enumDescriptions": [
+                                "Do not include any custom fields for the user.",
+                                "Include custom fields from schemas mentioned in customFieldMask.",
+                                "Include all fields associated with this user."
+                            ],
+                            "location": "query",
+                            "type": "string"
+                        },
                         "query": {
-                            "description": "Query string search. Should be of the form \"\" where field can be any of supported fields, operators can be one of '=' for exact match or ':' for prefix match. For prefix match, the value should always be followed by a *.",
+                            "description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-users",
                             "location": "query",
                             "type": "string"
                         },
                         "showDeleted": {
                             "description": "If set to true retrieves the list of deleted users. Default is false",
                             "location": "query",
                             "type": "string"
                         },
                         "sortOrder": {
                             "description": "Whether to return results in ascending or descending order.",
                             "enum": [
                                 "ASCENDING",
                                 "DESCENDING"
                             ],
                             "enumDescriptions": [
                                 "Ascending order.",
                                 "Descending order."
                             ],
                             "location": "query",
                             "type": "string"
+                        },
+                        "viewType": {
+                            "default": "admin_view",
+                            "description": "Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.",
+                            "enum": [
+                                "admin_view",
+                                "domain_public"
+                            ],
+                            "enumDescriptions": [
+                                "Fetches the ADMIN_VIEW of the user.",
+                                "Fetches the DOMAIN_PUBLIC view of the user."
+                            ],
+                            "location": "query",
+                            "type": "string"
                         }
                     },
                     "path": "users/watch",
                     "request": {
                         "$ref": "Channel",
                         "parameterName": "resource"
                     },
                     "response": {
                         "$ref": "Channel"
                     },
@@ skipping 311 matching lines @@
                     "response": {
                         "$ref": "VerificationCodes"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/admin.directory.user.security"
                     ]
                 }
             }
         }
     },
-    "revision": "20140905",
+    "revision": "20140919",
     "rootUrl": "https://www.googleapis.com/",
     "schemas": {
         "Alias": {
             "description": "JSON template for Alias object in Directory API.",
             "id": "Alias",
             "properties": {
                 "alias": {
                     "description": "A alias email",
                     "type": "string"
                 },
@@ skipping 775 matching lines @@
                 "organizationUnits": {
                     "description": "List of user objects.",
                     "items": {
                         "$ref": "OrgUnit"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
+        "Schema": {
+            "description": "JSON template for Schema resource in Directory API.",
+            "id": "Schema",
+            "properties": {
+                "etag": {
+                    "description": "ETag of the resource.",
+                    "type": "string"
+                },
+                "fields": {
+                    "annotations": {
+                        "required": [
+                            "directory.schemas.insert",
+                            "directory.schemas.update"
+                        ]
+                    },
+                    "description": "Fields of Schema",
+                    "items": {
+                        "$ref": "SchemaFieldSpec"
+                    },
+                    "type": "array"
+                },
+                "kind": {
+                    "default": "admin#directory#schema",
+                    "description": "Kind of resource this is.",
+                    "type": "string"
+                },
+                "schemaId": {
+                    "description": "Unique identifier of Schema (Read-only)",
+                    "type": "string"
+                },
+                "schemaName": {
+                    "annotations": {
+                        "required": [
+                            "directory.schemas.insert"
+                        ]
+                    },
+                    "description": "Schema name",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "SchemaFieldSpec": {
+            "description": "JSON template for FieldSpec resource for Schemas in Directory API.",
+            "id": "SchemaFieldSpec",
+            "properties": {
+                "etag": {
+                    "description": "ETag of the resource.",
+                    "type": "string"
+                },
+                "fieldId": {
+                    "description": "Unique identifier of Field (Read-only)",
+                    "type": "string"
+                },
+                "fieldName": {
+                    "annotations": {
+                        "required": [
+                            "directory.schemas.insert",
+                            "directory.schemas.update"
+                        ]
+                    },
+                    "description": "Name of the field.",
+                    "type": "string"
+                },
+                "fieldType": {
+                    "annotations": {
+                        "required": [
+                            "directory.schemas.insert",
+                            "directory.schemas.update"
+                        ]
+                    },
+                    "description": "Type of the field.",
+                    "type": "string"
+                },
+                "indexed": {
+                    "default": "true",
+                    "description": "Boolean specifying whether the field is indexed or not.",
+                    "type": "boolean"
+                },
+                "kind": {
+                    "default": "admin#directory#schema#fieldspec",
+                    "description": "Kind of resource this is.",
+                    "type": "string"
+                },
+                "multiValued": {
+                    "annotations": {
+                        "required": [
+                            "directory.schemas.insert",
+                            "directory.schemas.update"
+                        ]
+                    },
+                    "description": "Boolean specifying whether this is a multi-valued field or not.",
+                    "type": "boolean"
+                },
+                "numericIndexingSpec": {
+                    "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.",
+                    "properties": {
+                        "maxValue": {
+                            "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.",
+                            "format": "double",
+                            "type": "number"
+                        },
+                        "minValue": {
+                            "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.",
+                            "format": "double",
+                            "type": "number"
+                        }
+                    },
+                    "type": "object"
+                },
+                "readAccessType": {
+                    "default": "ALL_DOMAIN_USERS",
+                    "description": "Read ACLs on the field specifying who can view values of this field. Valid values are \"ALL_DOMAIN_USERS\" and \"ADMINS_AND_SELF\".",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
+        "Schemas": {
+            "description": "JSON response template for List Schema operation in Directory API.",
+            "id": "Schemas",
+            "properties": {
+                "etag": {
+                    "description": "ETag of the resource.",
+                    "type": "string"
+                },
+                "kind": {
+                    "default": "admin#directory#schemas",
+                    "description": "Kind of resource this is.",
+                    "type": "string"
+                },
+                "schemas": {
+                    "description": "List of UserSchema objects.",
+                    "items": {
+                        "$ref": "Schema"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "Token": {
             "description": "JSON template for token resource in Directory API.",
             "id": "Token",
             "properties": {
                 "anonymous": {
                     "description": "Whether the application is registered with Google. The value is true if the application has an anonymous Client ID.",
                     "type": "boolean"
                 },
                 "clientId": {
                     "description": "The Client ID of the application the token is issued to.",
@@ skipping 47 matching lines @@
                 },
                 "kind": {
                     "default": "admin#directory#tokenList",
                     "description": "The type of the API resource. This is always admin#directory#tokenList.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "User": {
-            "description": "JSON template for User object in Apps Directory API.",
+            "description": "JSON template for User object in Directory API.",
             "id": "User",
             "properties": {
                 "addresses": {
                     "type": "any"
                 },
                 "agreedToTerms": {
                     "description": "Indicates if user has agreed to terms (Read-only)",
                     "type": "boolean"
                 },
                 "aliases": {
                     "description": "List of aliases (Read-only)",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "changePasswordAtNextLogin": {
                     "description": "Boolean indicating if the user should change password in next login",
                     "type": "boolean"
                 },
                 "creationTime": {
                     "description": "User's Google account creation time. (Read-only)",
                     "format": "date-time",
                     "type": "string"
                 },
+                "customSchemas": {
+                    "additionalProperties": {
+                        "$ref": "UserCustomProperties"
+                    },
+                    "description": "Custom fields of the user.",
+                    "type": "object"
+                },
                 "customerId": {
                     "description": "CustomerId of User (Read-only)",
                     "type": "string"
                 },
                 "deletionTime": {
                     "format": "date-time",
                     "type": "string"
                 },
                 "emails": {
                     "type": "any"
@@ skipping 160 matching lines @@
                     "description": "Street.",
                     "type": "string"
                 },
                 "type": {
                     "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.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
+        "UserCustomProperties": {
+            "additionalProperties": {
+                "type": "any"
+            },
+            "description": "JSON template for a set of custom properties (i.e. all fields in a particular schema)",
+            "id": "UserCustomProperties",
+            "type": "object"
+        },
         "UserEmail": {
             "description": "JSON template for an email.",
             "id": "UserEmail",
             "properties": {
                 "address": {
                     "description": "Email id of the user.",
                     "type": "string"
                 },
                 "customType": {
                     "description": "Custom Type.",
@@ skipping 333 matching lines @@
                     "type": "string"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "admin/directory/v1/",
     "title": "Admin Directory API",
     "version": "directory_v1"
 }