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.
account_sid
type: SID<AC>The SID of the Account that created the Document Permission resource.
^AC[0-9a-fA-F]{32}$
34
34
service_sid
type: SID<IS>The SID of the Sync Service the resource is associated with.
^IS[0-9a-fA-F]{32}$
34
34
document_sid
type: SID<ET>The SID of the Sync Document to which the Document Permission applies.
^ET[0-9a-fA-F]{32}$
34
34
identity
type: stringThe application-defined string that uniquely identifies the resource's User within the Service to an FPA token.
GET https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
ServiceSid
type: stringThe SID of the Sync Service with the Document Permission resource to fetch.
DocumentSid
type: stringThe SID of the Sync Document with the Document Permission resource to fetch. Can be the Document resource's sid
or its unique_name
.
Identity
type: stringThe application-defined string that uniquely identifies the User's Document Permission resource to fetch.
GET https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions
ServiceSid
type: stringThe SID of the Sync Service with the Document Permission resources to read.
DocumentSid
type: stringThe SID of the Sync Document with the Document Permission resources to read. Can be the Document resource's sid
or its unique_name
.
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
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.
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.
ServiceSid
type: stringThe SID of the Sync Service with the Document Permission resource to update.
DocumentSid
type: stringThe SID of the Sync Document with the Document Permission resource to update. Can be the Document resource's sid
or its unique_name
.
Identity
type: stringThe application-defined string that uniquely identifies the User's Document Permission resource to update.
Read
type: booleanRequiredWhether the identity can read the Sync Document. Default value is false
.
Write
type: booleanRequiredWhether the identity can update the Sync Document. Default value is false
.
Manage
type: booleanRequiredWhether the identity can delete the Sync Document. Default value is false
.
DELETE https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
ServiceSid
type: stringThe SID of the Sync Service with the Document Permission resource to delete.
DocumentSid
type: stringThe SID of the Sync Document with the Document Permission resource to delete. Can be the Document resource's sid
or its unique_name
.
Identity
type: stringThe application-defined string that uniquely identifies the User's Document Permission resource to delete.