POST api/2.0/files/thirdparty This function requires authentication

Description

Saves the third-party storage service account. For WebDav, Yandex, kDrive and SharePoint, the login and password are used for authentication. For other providers, the authentication is performed using a token received via OAuth 2.0.

Parameters

Name	Description	Type	Example
url sent in body	Connection URL for the sharepoint	string	some text
login sent in body	Login	string	some text
password sent in body	Password	string	some text
token sent in body	Authentication token	string	some text
isCorporate sent in body	Specifies if this is a corporate account or not	Bool value	true
customerTitle sent in body	Customer title	string	some text
providerKey sent in body	Provider key	string	some text
providerId sent in body	Provider ID	string	some text

Remark

List of provider keys: DropboxV2, Box, WebDav, Yandex, OneDrive, SharePoint, GoogleDrive, kDrive.

Example

POST api/2.0/files/thirdparty
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "url": "some text",
  "login": "some text",
  "password": "some text",
  "token": "some text",
  "isCorporate": true,
  "customerTitle": "some text",
  "providerKey": "some text",
  "providerId": "some text"
}

Returns

Folder contents

Example Response

application/json

{
  "status": 0,
  "response": {
    "RootFolderType": 2,
    "UpdatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Created": "2020-12-13T17:13:31.5902727Z",
    "CreatedBy": {
      "Id": "00000000-0000-0000-0000-000000000000",
      "DisplayName": "Mike Zanyatski",
      "Title": "Manager",
      "AvatarSmall": "url to small avatar",
      "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
    },
    "Updated": "2020-12-13T17:13:31.5902727Z",
    "ProviderItem": true,
    "ProviderKey": "1234d",
    "ProviderId": 1234,
    "ParentId": 1840746475,
    "FilesCount": 1840746475,
    "FoldersCount": 1840746475,
    "IsShareable": true,
    "Id": 857864274,
    "Title": "Some titile.txt",
    "Access": 1,
    "Shared": false
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <RootFolderType>2</RootFolderType>
    <UpdatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <Created>2020-12-13T17:13:31.5902727Z</Created>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <Updated>2020-12-13T17:13:31.5902727Z</Updated>
    <ProviderItem>True</ProviderItem>
    <ProviderKey>1234d</ProviderKey>
    <ProviderId>1234</ProviderId>
    <ParentId>1840746475</ParentId>
    <FilesCount>1840746475</FilesCount>
    <FoldersCount>1840746475</FoldersCount>
    <IsShareable>True</IsShareable>
    <Id>857864274</Id>
    <Title>Some titile.txt</Title>
    <Access>1</Access>
    <Shared>False</Shared>
  </response>
</result>

POST api/2.0/files/thirdparty This function requires authentication

Get information

Get help