Google Admin SDK Admin Sdk Admin Datatransfer Transfers API

openapi: 3.1.0
info:
  title: Admin SDK API Transfers API
  version: datatransfer_v1
  description: Generated from Google's published Discovery document for Admin SDK API (admin datatransfer_v1, revision 20261109).
    3 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
externalDocs:
  url: https://developers.google.com/workspace/admin/
servers:
- url: https://admin.googleapis.com
paths:
  /admin/datatransfer/v1/transfers/{dataTransferId}:
    get:
      operationId: datatransfer.transfers.get
      summary: Get transfers
      description: Retrieves a data transfer request by its resource ID.
      parameters:
      - name: dataTransferId
        in: path
        required: true
        description: ID of the resource to be retrieved. This is returned in the response from the insert method.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataTransfer'
        4XX:
          content: &id001
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id001
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.datatransfer
        - https://www.googleapis.com/auth/admin.datatransfer.readonly
      - apiKey: []
      tags:
      - Transfers
  /admin/datatransfer/v1/transfers:
    get:
      operationId: datatransfer.transfers.list
      summary: List transfers
      description: Lists the transfers for a customer by source user, destination user, or status.
      parameters:
      - name: customerId
        in: query
        required: false
        description: Immutable ID of the Google Workspace account.
        schema:
          type: string
      - name: maxResults
        in: query
        required: false
        description: Maximum number of results to return. Default is 100.
        schema:
          minimum: 1
          format: int32
          maximum: 500
          type: integer
      - name: newOwnerUserId
        in: query
        required: false
        description: Destination user's profile ID.
        schema:
          type: string
      - name: oldOwnerUserId
        in: query
        required: false
        description: Source user's profile ID.
        schema:
          type: string
      - name: pageToken
        in: query
        required: false
        description: Token to specify the next page in the list.
        schema:
          type: string
      - name: status
        in: query
        required: false
        description: Status of the transfer.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataTransfersListResponse'
        4XX:
          content: &id002
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id002
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.datatransfer
        - https://www.googleapis.com/auth/admin.datatransfer.readonly
      - apiKey: []
      tags:
      - Transfers
    post:
      operationId: datatransfer.transfers.insert
      summary: Insert transfers
      description: Inserts a data transfer request. See the [Transfer parameters](https://developers.google.com/workspace/admin/data-transfer/v1/parameters)
        reference for specific application requirements.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataTransfer'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataTransfer'
        4XX:
          content: &id003
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id003
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.datatransfer
      - apiKey: []
      tags:
      - Transfers
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/admin.datatransfer.readonly: View data transfers between users in your organization
            https://www.googleapis.com/auth/admin.datatransfer: View and manage data transfers between users in your organization
  schemas:
    ApplicationDataTransfer:
      type: object
      description: Template to map fields of ApplicationDataTransfer resource.
      properties:
        applicationId:
          description: The application's ID.
          type: string
          format: int64
        applicationTransferParams:
          type: array
          items:
            $ref: '#/components/schemas/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](https://developers.google.com/workspace/admin/data-transfer/v1/parameters)
            reference.
        applicationTransferStatus:
          description: Read-only. Current status of transfer for this application.
          type: string
    ApplicationTransferParam:
      type: object
      properties:
        key:
          type: string
          description: The type of the transfer parameter, such as `PRIVACY_LEVEL`.
        value:
          items:
            type: string
          description: The value of the transfer parameter, such as `PRIVATE` or `SHARED`.
          type: array
      description: Template for application transfer parameters.
    DataTransfer:
      properties:
        overallTransferStatusCode:
          description: Read-only. Overall transfer status.
          type: string
        id:
          description: Read-only. The transfer's ID.
          type: string
        kind:
          default: admin#datatransfer#DataTransfer
          type: string
          description: Identifies the resource as a DataTransfer request.
        applicationDataTransfers:
          items:
            $ref: '#/components/schemas/ApplicationDataTransfer'
          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.
          type: array
        oldOwnerUserId:
          description: ID of the user whose data is being transferred.
          type: string
        newOwnerUserId:
          type: string
          description: ID of the user to whom the data is being transferred.
        etag:
          type: string
          description: ETag of the resource.
        requestTime:
          type: string
          description: Read-only. The time at which the data transfer was requested.
          format: date-time
      type: object
      description: A Transfer resource represents the transfer of the ownership of user data between users.
    DataTransfersListResponse:
      type: object
      description: Template for a collection of DataTransfer resources.
      properties:
        kind:
          description: Identifies the resource as a collection of data transfer requests.
          type: string
          default: admin#datatransfer#dataTransfersList
        dataTransfers:
          items:
            $ref: '#/components/schemas/DataTransfer'
          type: array
          description: List of data transfer requests.
        nextPageToken:
          description: Token to specify the next page in the list.
          type: string
        etag:
          type: string
          description: ETag of the resource.
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
x-provenance:
  method: harvested
  publisher: Google
  source: https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261109)