Index: discovery/googleapis/admin__directory_v1.json |
diff --git a/discovery/googleapis/admin__directory_v1.json b/discovery/googleapis/admin__directory_v1.json |
index bb12303af1e85799333f6c1e13b9d3b8ed6a9e2c..ae35668699d4abd23143775515caffabc2c90e55 100644 |
--- a/discovery/googleapis/admin__directory_v1.json |
+++ b/discovery/googleapis/admin__directory_v1.json |
@@ -52,6 +52,12 @@ |
}, |
"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" |
} |
} |
} |
@@ -63,7 +69,7 @@ |
"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" |
@@ -1468,6 +1474,184 @@ |
} |
} |
}, |
+ "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": { |
@@ -1582,11 +1766,46 @@ |
"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}", |
@@ -1618,6 +1837,11 @@ |
"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", |
@@ -1675,8 +1899,24 @@ |
"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" |
}, |
@@ -1697,6 +1937,20 @@ |
], |
"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", |
@@ -1812,6 +2066,11 @@ |
"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", |
@@ -1869,8 +2128,24 @@ |
"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" |
}, |
@@ -1891,6 +2166,20 @@ |
], |
"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", |
@@ -2222,7 +2511,7 @@ |
} |
} |
}, |
- "revision": "20140905", |
+ "revision": "20140919", |
"rootUrl": "https://www.googleapis.com/", |
"schemas": { |
"Alias": { |
@@ -3018,6 +3307,147 @@ |
}, |
"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", |
@@ -3085,7 +3515,7 @@ |
"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": { |
@@ -3111,6 +3541,13 @@ |
"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" |
@@ -3291,6 +3728,14 @@ |
}, |
"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", |