rclone/docs/content
nielash 1473de3f04 onedrive: add metadata support
This change adds support for metadata on OneDrive. Metadata (including
permissions) is supported for both files and directories.

OneDrive supports System Metadata (not User Metadata, as of this writing.) Much
of the metadata is read-only, and there are some differences between OneDrive
Personal and Business (see table in OneDrive backend docs for details).

Permissions are also supported, if --onedrive-metadata-permissions is set. The
accepted values for --onedrive-metadata-permissions are read, write, read,write, and
off (the default). write supports adding new permissions, updating the "role" of
existing permissions, and removing permissions. Updating and removing require
the Permission ID to be known, so it is recommended to use read,write instead of
write if you wish to update/remove permissions.

Permissions are read/written in JSON format using the same schema as the
OneDrive API, which differs slightly between OneDrive Personal and Business.
(See OneDrive backend docs for examples.)

To write permissions, pass in a "permissions" metadata key using this same
format. The --metadata-mapper tool can be very helpful for this.

When adding permissions, an email address can be provided in the User.ID or
DisplayName properties of grantedTo or grantedToIdentities. Alternatively, an
ObjectID can be provided in User.ID. At least one valid recipient must be
provided in order to add a permission for a user. Creating a Public Link is also
supported, if Link.Scope is set to "anonymous".

Note that adding a permission can fail if a conflicting permission already
exists for the file/folder.

To update an existing permission, include both the Permission ID and the new
roles to be assigned. roles is the only property that can be changed.

To remove permissions, pass in a blob containing only the permissions you wish
to keep (which can be empty, to remove all.)

Note that both reading and writing permissions requires extra API calls, so if
you don't need to read or write permissions it is recommended to omit --onedrive-
metadata-permissions.

Metadata and permissions are supported for Folders (directories) as well as
Files. Note that setting the mtime or btime on a Folder requires one extra API
call on OneDrive Business only.

OneDrive does not currently support User Metadata. When writing metadata, only
writeable system properties will be written -- any read-only or unrecognized keys
passed in will be ignored.

TIP: to see the metadata and permissions for any file or folder, run:

rclone lsjson remote:path --stat -M --onedrive-metadata-permissions read

See the OneDrive backend docs for a table of all the supported metadata
properties.
2024-03-08 14:48:54 +00:00
..
commands sync: report list of synced paths to file -- see #7282 2024-01-20 14:50:08 -05:00
oracleobjectstorage docs: fix typos found by codespell in docs and code comments 2023-09-23 12:20:01 +01:00
_index.md docs: add bisync to index 2024-01-20 14:50:08 -05:00
alias.md docs: Add minimum versions to all the backend pages and some of the other pages 2022-11-18 14:41:24 +00:00
amazonclouddrive.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
authors.md Add huajin tong to contributors 2024-03-07 14:44:45 +00:00
azureblob.md Version v1.65.0 2023-11-26 16:07:39 +00:00
azurefiles.md azurefiles: finish docs and implementation and add optional interfaces 2023-11-18 16:48:23 +00:00
b2.md Version v1.65.0 2023-11-26 16:07:39 +00:00
bisync.md docs: fix some comments 2024-03-07 12:57:15 +00:00
box.md Version v1.65.0 2023-11-26 16:07:39 +00:00
bugs.md docs: update to reflect dir modtime/metadata support 2024-03-07 11:09:07 +00:00
cache.md docs: add badge for experimental/beta/deprecated status next to version in backend docs 2022-12-03 18:58:55 +01:00
changelog.md Changelog updates from Version v1.65.2 2024-01-24 16:40:47 +00:00
chunker.md docs: cleanup backend hashes sections 2023-11-20 17:43:57 +00:00
combine.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
compress.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
contact.md docs: update contact page on website 2023-07-05 16:57:07 +01:00
crypt.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
docker.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
docs.md fs: Implement --no-update-dir-modtime to disable setting modification times on dirs 2024-03-07 17:20:24 +00:00
downloads.md docs: add rclone OS requirements 2024-01-17 16:42:33 +00:00
drive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
dropbox.md Version v1.65.0 2023-11-26 16:07:39 +00:00
faq.md docs: faq: add solution for port opening issues on Windows 2023-06-25 11:20:54 +01:00
fichier.md Version v1.65.0 2023-11-26 16:07:39 +00:00
filefabric.md Version v1.65.0 2023-11-26 16:07:39 +00:00
filtering.md add missing backtick 2024-01-19 11:17:36 +00:00
flags.md Version v1.65.0 2023-11-26 16:07:39 +00:00
ftp.md Version v1.65.0 2023-11-26 16:07:39 +00:00
googlecloudstorage.md Version v1.65.0 2023-11-26 16:07:39 +00:00
googlephotos.md Version v1.65.0 2023-11-26 16:07:39 +00:00
gui.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
hasher.md docs: fix typos found by codespell 2023-03-24 20:49:00 +00:00
hdfs.md Version v1.65.0 2023-11-26 16:07:39 +00:00
hidrive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
http.md Version v1.65.0 2023-11-26 16:07:39 +00:00
imagekit.md Version v1.65.0 2023-11-26 16:07:39 +00:00
install.md docs: document how to build with version info and icon resources on windows 2023-11-01 12:44:04 +01:00
install.sh install.sh: fix harmless error message on install 2023-11-28 19:10:04 +00:00
internetarchive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
jottacloud.md Version v1.65.0 2023-11-26 16:07:39 +00:00
KEYS docs: document release signing and verification 2023-09-11 12:28:23 +01:00
koofr.md Version v1.65.0 2023-11-26 16:07:39 +00:00
licence.md docs: fix typo in license webpage 2022-07-06 11:25:31 +01:00
linkbox.md backend: add Linkbox backend 2023-11-18 17:14:45 +00:00
local.md Version v1.65.0 2023-11-26 16:07:39 +00:00
mailru.md Version v1.65.0 2023-11-26 16:07:39 +00:00
mega.md Version v1.65.0 2023-11-26 16:07:39 +00:00
memory.md docs: cleanup backend hashes sections 2023-11-20 17:43:57 +00:00
netstorage.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
onedrive.md onedrive: add metadata support 2024-03-08 14:48:54 +00:00
opendrive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
oracleobjectstorage.md oracleobjectstorage: supports workload identity authentication for OKE 2024-02-20 16:25:59 +00:00
overview.md onedrive: add metadata support 2024-03-08 14:48:54 +00:00
pcloud.md Version v1.65.0 2023-11-26 16:07:39 +00:00
pikpak.md Version v1.65.0 2023-11-26 16:07:39 +00:00
premiumizeme.md Version v1.65.0 2023-11-26 16:07:39 +00:00
privacy.md docs: improve grammar and fix typos (#5361) 2021-11-04 12:50:43 +01:00
protondrive.md Version v1.65.0 2023-11-26 16:07:39 +00:00
putio.md Version v1.65.0 2023-11-26 16:07:39 +00:00
qingstor.md Version v1.65.0 2023-11-26 16:07:39 +00:00
quatrix.md quatrix: add option to skip project folders 2024-02-18 07:38:19 +01:00
rc.md rc: add srcFs and dstFs to core/stats and core/transferred stats 2024-02-02 11:43:10 +00:00
release_signing.md docs: document release signing and verification 2023-09-11 12:28:23 +01:00
remote_setup.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
s3.md amazonclouddrive: remove Amazon Drive backend code and docs #7539 2024-01-04 17:05:54 +00:00
seafile.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sftp.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sharefile.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sia.md Version v1.65.0 2023-11-26 16:07:39 +00:00
smb.md Version v1.65.0 2023-11-26 16:07:39 +00:00
sponsor.md docs: rename donate page to sponsor page and rework 2023-06-30 14:32:53 +01:00
storj.md storj: update satellite urls and labels 2023-02-06 13:18:15 +00:00
sugarsync.md Version v1.65.0 2023-11-26 16:07:39 +00:00
swift.md Version v1.65.0 2023-11-26 16:07:39 +00:00
tardigrade.md docs: show only significant parts of version number in version introduced label 2022-12-21 12:41:47 +00:00
union.md union: fix documentation 2023-10-21 10:37:43 +01:00
uptobox.md Version v1.65.0 2023-11-26 16:07:39 +00:00
webdav.md docs: Fix a heading level in webdav.md documentation (#7631) 2024-02-18 07:16:23 +01:00
yandex.md Version v1.65.0 2023-11-26 16:07:39 +00:00
zoho.md Version v1.65.0 2023-11-26 16:07:39 +00:00