2024-06-05 12:19:46 +02:00
|
|
|
---
|
|
|
|
sidebar_position: 3
|
|
|
|
---
|
|
|
|
|
|
|
|
# Add user to file
|
|
|
|
Defines access to the file for an external user
|
|
|
|
|
|
|
|
|
2024-07-10 10:59:55 +02:00
|
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
2024-06-05 12:19:46 +02:00
|
|
|
*Function AddUsersToFile(Val Token, Val FileID, Val EmailAddresses, Val ViewOnly = True) Export*
|
|
|
|
|
|
|
|
| Parameter | CLI option | Type | Destination |
|
|
|
|
|-|-|-|-|
|
|
|
|
| Token | --token | String | Token |
|
|
|
|
| FileID | --fileid | String | ID of the file to be accessed |
|
|
|
|
| EmailAddresses | --emails | String, Array of String | List of email addresses of users being added |
|
|
|
|
| ViewOnly | --readonly | Boolean | Prohibits file editing for the external user |
|
|
|
|
|
|
|
|
|
2024-06-06 14:33:52 +02:00
|
|
|
Returns: Map Of KeyAndValue - serialized JSON response from Dropbox
|
2024-06-05 12:19:46 +02:00
|
|
|
|
2024-07-10 10:59:55 +02:00
|
|
|
|
2024-06-05 12:19:46 +02:00
|
|
|
```bsl title="Code example"
|
|
|
|
Token = "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L...";
|
|
|
|
Email = "h5bk6ft62s@privaterelay.appleid.com";
|
|
|
|
File = "kJU6-a-pT48AAAAAAAAABw";
|
|
|
|
|
|
|
|
Result = OPI_Dropbox.AddUsersToFile(Token, File, Email, False);
|
|
|
|
```
|
2024-07-10 10:59:55 +02:00
|
|
|
|
|
|
|
|
2024-06-05 12:19:46 +02:00
|
|
|
|
|
|
|
```sh title="CLI command example"
|
|
|
|
|
|
|
|
oint dropbox AddUsersToFile --token "sl.B2ieEHcB9I9BTwJFjbf_MQtoZMKjGYgkpBqzQkvBfuSz41Qpy5r3d7a4ax22I5ILWhd9KLbN5L..." --fileid %fileid% --emails %emails% --readonly %readonly%
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
```json title="Result"
|
2024-07-10 10:59:55 +02:00
|
|
|
[
|
2024-06-20 09:39:55 +02:00
|
|
|
{
|
|
|
|
"member": {
|
|
|
|
".tag": "email",
|
|
|
|
"email": "h5bk6ft62s@privaterelay.appleid.com"
|
|
|
|
},
|
|
|
|
"result": {
|
|
|
|
".tag": "success",
|
|
|
|
"success": {
|
|
|
|
".tag": "editor"
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"sckey_sha1": "ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4",
|
|
|
|
"invitation_signature": [
|
|
|
|
"ee2d8fd2cee052e103a52aa74be85bbebb8e6bb4:ed7721b375882c806612d4056dad9f317cc98a22"
|
|
|
|
]
|
|
|
|
}
|
|
|
|
]
|
2024-06-05 12:19:46 +02:00
|
|
|
```
|