{ "packagePath": "admin", "schemas": { "DataTransfersListResponse": { "description": "Template for a collection of DataTransfer resources.", "id": "DataTransfersListResponse", "type": "object", "properties": { "kind": { "type": "string", "description": "Identifies the resource as a collection of data transfer requests.", "default": "admin#datatransfer#dataTransfersList" }, "etag": { "type": "string", "description": "ETag of the resource." }, "dataTransfers": { "description": "List of data transfer requests.", "items": { "$ref": "DataTransfer" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Token to specify the next page in the list." } } }, "DataTransfer": { "id": "DataTransfer", "type": "object", "description": "A Transfer resource represents the transfer of the ownership of user data between users.", "properties": { "etag": { "type": "string", "description": "ETag of the resource." }, "id": { "description": "Read-only. The transfer's ID.", "type": "string" }, "oldOwnerUserId": { "description": "ID of the user whose data is being transferred.", "type": "string" }, "kind": { "default": "admin#datatransfer#DataTransfer", "description": "Identifies the resource as a DataTransfer request.", "type": "string" }, "applicationDataTransfers": { "description": "The list of per-application data transfer resources. It contains details of the applications associated with this transfer resource, and also specifies the applications for which data transfer has to be done at the time of the transfer resource creation.", "items": { "$ref": "ApplicationDataTransfer" }, "type": "array" }, "overallTransferStatusCode": { "description": "Read-only. Overall transfer status.", "type": "string" }, "requestTime": { "description": "Read-only. The time at which the data transfer was requested.", "type": "string", "format": "date-time" }, "newOwnerUserId": { "description": "ID of the user to whom the data is being transferred.", "type": "string" } } }, "ApplicationsListResponse": { "properties": { "applications": { "description": "The list of applications that support data transfer and are also installed for the customer.", "items": { "$ref": "Application" }, "type": "array" }, "kind": { "description": "Identifies the resource as a collection of Applications.", "default": "admin#datatransfer#applicationsList", "type": "string" }, "nextPageToken": { "description": "Token to specify the next page in the list.", "type": "string" }, "etag": { "description": "ETag of the resource.", "type": "string" } }, "type": "object", "id": "ApplicationsListResponse", "description": "Template for a collection of Applications." }, "Application": { "id": "Application", "type": "object", "properties": { "etag": { "description": "Etag of the resource.", "type": "string" }, "id": { "description": "The application's ID. Retrievable by using the [`applications.list()`](/admin-sdk/data-transfer/reference/rest/v1/applications/list) method.", "format": "int64", "type": "string" }, "transferParams": { "type": "array", "description": "The list of all possible transfer parameters for this application. These parameters select which categories of the user's data to transfer.", "items": { "$ref": "ApplicationTransferParam" } }, "kind": { "default": "admin#datatransfer#ApplicationResource", "description": "Identifies the resource as a DataTransfer Application Resource.", "type": "string" }, "name": { "type": "string", "description": "The application's name." } }, "description": "Application resources represent applications installed on the domain that support transferring ownership of user data." }, "ApplicationDataTransfer": { "description": "Template to map fields of ApplicationDataTransfer resource.", "type": "object", "properties": { "applicationTransferStatus": { "type": "string", "description": "Read-only. Current status of transfer for this application." }, "applicationId": { "format": "int64", "description": "The application's ID.", "type": "string" }, "applicationTransferParams": { "items": { "$ref": "ApplicationTransferParam" }, "description": "The transfer parameters for the application. These parameters are used to select the data which will get transferred in context of this application. For more information about the specific values available for each application, see the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference.", "type": "array" } }, "id": "ApplicationDataTransfer" }, "ApplicationTransferParam": { "id": "ApplicationTransferParam", "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" }, "description": "The value of the transfer parameter, such as `PRIVATE` or `SHARED`." }, "key": { "type": "string", "description": "The type of the transfer parameter, such as `PRIVACY_LEVEL`." } }, "description": "Template for application transfer parameters." } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/admin.datatransfer.readonly": { "description": "View data transfers between users in your organization" }, "https://www.googleapis.com/auth/admin.datatransfer": { "description": "View and manage data transfers between users in your organization" } } } }, "revision": "20221108", "rootUrl": "https://admin.googleapis.com/", "parameters": { "quotaUser": { "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.", "location": "query", "type": "string" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "key": { "location": "query", "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.", "type": "string" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "alt": { "default": "json", "enum": [ "json", "media", "proto" ], "location": "query", "description": "Data format for response.", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "type": "string" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "upload_protocol": { "location": "query", "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "location": "query" } }, "mtlsRootUrl": "https://admin.mtls.googleapis.com/", "id": "admin:datatransfer_v1", "name": "admin", "resources": { "applications": { "methods": { "get": { "description": "Retrieves information about an application for the given application ID.", "id": "datatransfer.applications.get", "flatPath": "admin/datatransfer/v1/applications/{applicationId}", "parameterOrder": [ "applicationId" ], "response": { "$ref": "Application" }, "parameters": { "applicationId": { "description": "ID of the application resource to be retrieved.", "required": true, "format": "int64", "location": "path", "type": "string" } }, "path": "admin/datatransfer/v1/applications/{applicationId}", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/admin.datatransfer", "https://www.googleapis.com/auth/admin.datatransfer.readonly" ] }, "list": { "parameterOrder": [], "flatPath": "admin/datatransfer/v1/applications", "description": "Lists the applications available for data transfer for a customer.", "scopes": [ "https://www.googleapis.com/auth/admin.datatransfer", "https://www.googleapis.com/auth/admin.datatransfer.readonly" ], "parameters": { "pageToken": { "location": "query", "type": "string", "description": "Token to specify next page in the list." }, "maxResults": { "maximum": "500", "location": "query", "format": "int32", "description": "Maximum number of results to return. Default is 100.", "minimum": "1", "type": "integer" }, "customerId": { "location": "query", "type": "string", "description": "Immutable ID of the Google Workspace account." } }, "httpMethod": "GET", "id": "datatransfer.applications.list", "path": "admin/datatransfer/v1/applications", "response": { "$ref": "ApplicationsListResponse" } } } }, "transfers": { "methods": { "get": { "parameters": { "dataTransferId": { "description": "ID of the resource to be retrieved. This is returned in the response from the insert method.", "location": "path", "type": "string", "required": true } }, "id": "datatransfer.transfers.get", "response": { "$ref": "DataTransfer" }, "scopes": [ "https://www.googleapis.com/auth/admin.datatransfer", "https://www.googleapis.com/auth/admin.datatransfer.readonly" ], "flatPath": "admin/datatransfer/v1/transfers/{dataTransferId}", "description": "Retrieves a data transfer request by its resource ID.", "httpMethod": "GET", "parameterOrder": [ "dataTransferId" ], "path": "admin/datatransfer/v1/transfers/{dataTransferId}" }, "list": { "parameterOrder": [], "flatPath": "admin/datatransfer/v1/transfers", "scopes": [ "https://www.googleapis.com/auth/admin.datatransfer", "https://www.googleapis.com/auth/admin.datatransfer.readonly" ], "parameters": { "oldOwnerUserId": { "type": "string", "location": "query", "description": "Source user's profile ID." }, "customerId": { "type": "string", "description": "Immutable ID of the Google Workspace account.", "location": "query" }, "newOwnerUserId": { "location": "query", "description": "Destination user's profile ID.", "type": "string" }, "pageToken": { "description": "Token to specify the next page in the list.", "type": "string", "location": "query" }, "maxResults": { "location": "query", "maximum": "500", "description": "Maximum number of results to return. Default is 100.", "type": "integer", "format": "int32", "minimum": "1" }, "status": { "description": "Status of the transfer.", "location": "query", "type": "string" } }, "path": "admin/datatransfer/v1/transfers", "description": "Lists the transfers for a customer by source user, destination user, or status.", "id": "datatransfer.transfers.list", "httpMethod": "GET", "response": { "$ref": "DataTransfersListResponse" } }, "insert": { "parameters": {}, "httpMethod": "POST", "flatPath": "admin/datatransfer/v1/transfers", "request": { "$ref": "DataTransfer" }, "response": { "$ref": "DataTransfer" }, "scopes": [ "https://www.googleapis.com/auth/admin.datatransfer" ], "parameterOrder": [], "id": "datatransfer.transfers.insert", "description": "Inserts a data transfer request. See the [Transfer parameters](/admin-sdk/data-transfer/v1/parameters) reference for specific application requirements.", "path": "admin/datatransfer/v1/transfers" } } } }, "ownerDomain": "google.com", "batchPath": "batch", "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "documentationLink": "https://developers.google.com/admin-sdk/", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "kind": "discovery#restDescription", "version": "datatransfer_v1", "baseUrl": "https://admin.googleapis.com/", "title": "Admin SDK API", "basePath": "", "canonicalName": "DataTransfer", "protocol": "rest", "ownerName": "Google", "fullyEncodeReservedExpansion": true }