Skip to content Skip to navigation Skip to topbar

On this page

Document Permission Resource

The Document Permission resource represents the permissions that apply to any SDKs authenticated with a matching Identity specified in the Auth Token.

Permissions bind an identity to an object with flags that specify the permission to read, write, and manage the object. Permissions do not have a SID or a unique path; instead, they are identified by the Service, Object, and Token Identity specified in the URL.

Permissions can be updated, fetched, and read. Deleting a Document Permission resource is the same as setting all permissions to false.

We recommend following the standard URI specification and avoid the following reserved characters ! * ' ( ) ; : @ & = + $ , / ? % # [ ] for values such as identity and friendly name.

Document Permission properties

Property nameTypeRequiredDescriptionChild properties

account_sidSID<AC>Optional

The SID of the Account that created the Document Permission resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

service_sidSID<IS>Optional

The SID of the Sync Service the resource is associated with.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

document_sidSID<ET>Optional

The SID of the Sync Document to which the Document Permission applies.

Pattern: ^ET[0-9a-fA-F]{32}$Min length: 34Max length: 34

identitystringOptional

PII MTL: 30 days

The application-defined string that uniquely identifies the resource's User within the Service to an FPA token.

readbooleanOptional

Whether the identity can read the Sync Document.

writebooleanOptional

Whether the identity can update the Sync Document.

managebooleanOptional

Whether the identity can delete the Sync Document.

urlstring<uri>Optional

The absolute URL of the Sync Document Permission resource.

Fetch a Document Permission resource

GET https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

The SID of the Sync Service with the Document Permission resource to fetch.

DocumentSidstringrequired

The SID of the Sync Document with the Document Permission resource to fetch. Can be the Document resource's sid or its unique_name.

Identitystringrequired

PII MTL: 30 days

The application-defined string that uniquely identifies the User's Document Permission resource to fetch.

Fetch a Document Permission resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchDocumentPermission() {
11  const documentPermission = await client.sync.v1
12    .services("ServiceSid")
13    .documents("DocumentSid")
14    .documentPermissions("Identity")
15    .fetch();
16
17  console.log(documentPermission.accountSid);
18}
19
20fetchDocumentPermission();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "service_sid": "ServiceSid",
4  "document_sid": "DocumentSid",
5  "identity": "Identity",
6  "read": true,
7  "write": true,
8  "manage": true,
9  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity"
10}

Read multiple Document Permission resources

GET https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

The SID of the Sync Service with the Document Permission resources to read.

DocumentSidstringrequired

The SID of the Sync Document with the Document Permission resources to read. Can be the Document resource's sid or its unique_name.

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

Read multiple Document Permission resources

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listDocumentPermission() {
11  const documentPermissions = await client.sync.v1
12    .services("ServiceSid")
13    .documents("DocumentSid")
14    .documentPermissions.list({ limit: 20 });
15
16  documentPermissions.forEach((d) => console.log(d.accountSid));
17}
18
19listDocumentPermission();

Output

1{
2  "permissions": [],
3  "meta": {
4    "first_page_url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0",
5    "key": "permissions",
6    "next_page_url": null,
7    "page": 0,
8    "page_size": 50,
9    "previous_page_url": null,
10    "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/sidOrUniqueName/Permissions?PageSize=50&Page=0"
11  }
12}

Update a Document Permission resource

POST https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}

Updates the permissions of the document for the Identity specified in the URL.

(warning)

Warning

Permissions only take effect if the ACLEnabled flag is set on your Service instance.

Your servers are always in "God Mode", meaning they have full access to all your account's Sync resources regardless of the value of the Service's ACLEnabled flag or how the Permissions are configured.

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

The SID of the Sync Service with the Document Permission resource to update.

DocumentSidstringrequired

The SID of the Sync Document with the Document Permission resource to update. Can be the Document resource's sid or its unique_name.

Identitystringrequired

PII MTL: 30 days

The application-defined string that uniquely identifies the User's Document Permission resource to update.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

Readbooleanrequired

Whether the identity can read the Sync Document. Default value is false.

Writebooleanrequired

Whether the identity can update the Sync Document. Default value is false.

Managebooleanrequired

Whether the identity can delete the Sync Document. Default value is false.

Update a Document Permission resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateDocumentPermission() {
11  const documentPermission = await client.sync.v1
12    .services("ServiceSid")
13    .documents("DocumentSid")
14    .documentPermissions("Identity")
15    .update({
16      manage: false,
17      read: false,
18      write: false,
19    });
20
21  console.log(documentPermission.accountSid);
22}
23
24updateDocumentPermission();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "service_sid": "ServiceSid",
4  "document_sid": "DocumentSid",
5  "identity": "Identity",
6  "read": false,
7  "write": false,
8  "manage": false,
9  "url": "https://sync.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Documents/ETaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Permissions/identity"
10}

Delete a Document Permission resource

DELETE https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

The SID of the Sync Service with the Document Permission resource to delete.

DocumentSidstringrequired

The SID of the Sync Document with the Document Permission resource to delete. Can be the Document resource's sid or its unique_name.

Identitystringrequired

The application-defined string that uniquely identifies the User's Document Permission resource to delete.

Delete a Document Permission resource

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteDocumentPermission() {
11  await client.sync.v1
12    .services("ServiceSid")
13    .documents("DocumentSid")
14    .documentPermissions("Identity")
15    .remove();
16}
17
18deleteDocumentPermission();