Docusign Cloud Storage API

openapi: 3.2.0
info:
  title: Docusign Cloud Storage API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged CloudStorage across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: Cloud Storage
  description: The CloudStorage resource provides methods that allow you to list files stored on your cloud storage provider.
paths:
  /v2/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders:
    get:
      tags:
      - Cloud Storage
      summary: Docusign Retrieves a list of all the items in a specified folder from the…
      description: Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
      operationId: CloudStorageFolder_GetCloudStorageFolderAll
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: serviceId
        in: path
        description: "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.'
        required: true
        schema:
          type: string
      - name: cloud_storage_folder_path
        in: query
        description: 'A comma separated list of folder IDs included in the request. '
        schema:
          type: string
      - name: count
        in: query
        description: "An optional value that sets how many items are included in the response. \n\nThe default setting for this is 25. "
        schema:
          type: string
      - name: order
        in: query
        description: "An optional value that sets the direction order used to sort the item list. \n\nValid values are: \n\n* asc = ascending sort order\n* desc = descending sort order "
        schema:
          type: string
      - name: order_by
        in: query
        description: "An optional value that sets the file attribute used to sort the item list. \n\nValid values are: \n\n* modified\n* name  "
        schema:
          type: string
      - name: search_text
        in: query
        schema:
          type: string
      - name: start_position
        in: query
        description: 'Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.  '
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/externalFolder'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: listFolders
      x-ds-method: listFolders
      x-ds-service: CloudStorage
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}:
    get:
      tags:
      - Cloud Storage
      summary: Docusign Gets a list of all the items from the specified cloud storage provider
      description: Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.
      operationId: CloudStorageFolder_GetCloudStorageFolder
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: folderId
        in: path
        description: The ID of the folder being accessed.
        required: true
        schema:
          type: string
      - name: serviceId
        in: path
        description: "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: 'The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. **Note**: For the [GET /v2/accounts/{accountId}/envelopes](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges/#envelopesInformation) method, the `user_id` query parameter is not implemented and should not be used.'
        required: true
        schema:
          type: string
      - name: cloud_storage_folder_path
        in: query
        schema:
          type: string
      - name: count
        in: query
        description: "An optional value that sets how many items are included in the response. \n\nThe default setting for this is 25. "
        schema:
          type: string
      - name: order
        in: query
        description: "An optional value that sets the direction order used to sort the item list. \n\nValid values are: \n\n* asc = ascending sort order\n* desc = descending sort order "
        schema:
          type: string
      - name: order_by
        in: query
        description: "An optional value that sets the file attribute used to sort the item list. \n\nValid values are: \n\n* modified\n* name  "
        schema:
          type: string
      - name: search_text
        in: query
        schema:
          type: string
      - name: start_position
        in: query
        description: 'Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.  '
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/externalFolder'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: list
      x-ds-method: list
      x-ds-service: CloudStorage
      x-ds-in-sdk: true
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders:
    parameters: []
    get:
      tags:
      - Cloud Storage
      summary: Retrieves a list of all the items in a specified folder from the specified…
      description: Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
      operationId: getV21AccountsByAccountIdUsersByUserIdCloudStorageByServiceIdFolders
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: serviceId
        in: path
        description: "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: 'The ID of the user to access.


          **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user''s settings.'
        required: true
        schema:
          type: string
      - name: cloud_storage_folder_path
        in: query
        description: 'A comma separated list of folder IDs included in the request. '
        required: false
        schema:
          type: string
      - name: count
        in: query
        description: 'The maximum number of results to return.


          Use `start_position` to specify the number of results to skip.


          Default: `25`

          '
        required: false
        schema:
          type: string
      - name: order
        in: query
        description: "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
        required: false
        schema:
          type: string
      - name: order_by
        in: query
        description: "The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`"
        required: false
        schema:
          type: string
      - name: search_text
        in: query
        required: false
        description: Use this parameter to search for specific text.
        schema:
          type: string
      - name: start_position
        in: query
        description: 'The zero-based index of the

          result from which to start returning results.


          Use with `count` to limit the number

          of results.


          The default value is `0`.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/externalFolder_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: listFolders
      x-ds-method: listFolders
      x-ds-service: CloudStorage
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: CloudStorageFolder_GetCloudStorageFolderAll
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}:
    parameters: []
    get:
      tags:
      - Cloud Storage
      summary: Gets a list of items from a cloud storage provider
      description: 'Retrieves a list of the user''s items from the specified cloud storage provider.


        To limit the scope of the items returned, provide a comma-separated list of folder IDs in the request.'
      operationId: getV21AccountsByAccountIdUsersByUserIdCloudStorageByServiceIdFoldersByFolderId
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: folderId
        in: path
        description: The ID of the folder.
        required: true
        schema:
          type: string
      - name: serviceId
        in: path
        description: "The ID of the service to access. \n\nValid values are the service name (\"Box\") or the numerical serviceId (\"4136\")."
        required: true
        schema:
          type: string
      - name: userId
        in: path
        description: 'The ID of the user to access.


          **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user''s settings.'
        required: true
        schema:
          type: string
      - name: cloud_storage_folder_path
        in: query
        required: false
        description: The file path to a cloud storage folder.
        schema:
          type: string
      - name: cloud_storage_folderid_plain
        in: query
        required: false
        description: A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder IDs as a comma-separated list.
        schema:
          type: string
      - name: count
        in: query
        description: 'The maximum number of results to return.


          Use `start_position` to specify the number of results to skip.


          Default: `25`

          '
        required: false
        schema:
          type: string
      - name: order
        in: query
        description: "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
        required: false
        schema:
          type: string
      - name: order_by
        in: query
        description: "The file attribute to use to sort the results.\n\nValid values are: \n\n* `modified`\n* `name`"
        required: false
        schema:
          type: string
      - name: search_text
        in: query
        required: false
        description: Use this parameter to search for specific text.
        schema:
          type: string
      - name: sky_drive_skip_token
        in: query
        required: false
        description: ''
        schema:
          type: string
      - name: start_position
        in: query
        description: 'The zero-based index of the

          result from which to start returning results.


          Use with `count` to limit the number

          of results.


          The default value is `0`.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/externalFolder_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: list
      x-ds-method: list
      x-ds-service: CloudStorage
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: CloudStorageFolder_GetCloudStorageFolder
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    externalFile:
      type: object
      properties:
        date:
          type: string
          description: ''
        id:
          type: string
          description: ''
        img:
          type: string
          description: ''
        name:
          type: string
          description: ''
        size:
          type: string
          description: 'Reserved: TBD'
        supported:
          type: string
          description: ''
        type:
          type: string
          description: 'Type of the user. Valid values: type_owner, type_participant.'
        uri:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: externalFile
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    externalDocServiceErrorDetails:
      type: object
      properties:
        authenticationUrl:
          type: string
          description: 'Reserved: TBD'
        errorCode:
          type: string
          description: ''
        message:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: externalDocServiceErrorDetails
      x-ms-summary: ''
    externalFolder:
      type: object
      properties:
        endPosition:
          type: string
          description: 'The last position in the result set. '
        errorDetails:
          $ref: '#/components/schemas/externalDocServiceErrorDetails'
        id:
          type: string
          description: ''
        items:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/externalFile'
        name:
          type: string
          description: ''
        nextUri:
          type: string
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
        previousUri:
          type: string
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
        resultSetSize:
          type: string
          description: 'The number of results returned in this response. '
        startPosition:
          type: string
          description: Starting position of the current result set.
        totalSetSize:
          type: string
          description: The total number of items in the search's result set. It will always be greater than or equal to the value of the `resultSetSize` field.
      description: ''
      x-ds-definition-name: externalFolder
      x-ms-summary: ''
    externalFile_2:
      type: object
      properties:
        date:
          description: The UTC date and time that the file or folder was last modified.
          type: string
        hasCompositeTemplate:
          description: ''
          type: string
        id:
          description: The storage provider's ID for the file or folder.
          type: string
        img:
          description: 'The file extension for a file.


            **Note:** If the item is a folder, this value is null.'
          type: string
        name:
          description: The full name of a file.
          type: string
        ownerName:
          description: ''
          type: string
        size:
          description: The size of the file. The file size limit varies based on the cloud storage provider.
          type: string
        supported:
          description: When **true,** Docusign supports the file type for upload.
          type: string
        type:
          description: 'The type of cloud storage item. Valid values are:


            - `file`

            - `folder`'
          type: string
        uri:
          description: The URI for the file or folder.
          type: string
      description: This object contains information about a file or folder in cloud storage.
      x-ds-definition-name: externalFile
      x-ms-summary: This object contains information about a file or folder in cloud storage.
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    externalDocServiceErrorDetails_2:
      type: object
      properties:
        authenticationUrl:
          description: Reserved for Docusign.
          type: string
        errorCode:
          description: A code associated with the error condition.
          type: string
        message:
          description: ''
          type: string
      x-ds-definition-name: externalDocServiceErrorDetails
      description: ''
      x-ms-summary: ''
    externalFolder_2:
      type: object
      properties:
        endPosition:
          description: 'The last index position in the result set. '
          type: string
        errorDetails:
          $ref: '#/components/schemas/externalDocServiceErrorDetails_2'
          description: This object describes errors that occur. It is only valid for responses and ignored in requests.
        id:
          description: A unique ID for the Salesforce object.
          type: string
        items:
          description: If the tab is a list, this represents the values that are possible for the tab.
          type: array
          items:
            $ref: '#/components/schemas/externalFile_2'
        name:
          description: ''
          type: string
        nextUri:
          description: 'The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. '
          type: string
        previousUri:
          description: 'The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. '
          type: string
        resultSetSize:
          description: The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
          type: string
        skyDriveSkipToken:
          description: ''
          type: string
        startPosition:
          description: The starting index position of the current result set.
          type: string
        totalSetSize:
          description: The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.
          type: string
      x-ds-definition-name: externalFolder
      description: ''
      x-ms-summary: ''
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'