Menu

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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 permssion 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.

Document Permission properties

Resource Properties in REST API format
account_sid
sid<AC> Not PII

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

service_sid
sid<IS> Not PII

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

document_sid
sid<ET> Not PII

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

identity

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

read
boolean Not PII

Whether the identity can read the Sync Document.

write
boolean Not PII

Whether the identity can update the Sync Document.

manage
boolean Not PII

Whether the identity can delete the Sync Document.

url
url Not PII

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}
Parameters
Parameters in REST API format
service_sid
Path
get sid_like<IS> Not PII

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

document_sid
Path
get sid_like<ET> Not PII

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

identity
Path
get string PII MTL: 30 DAYS

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

Example 1
        
        
        
        

        Read multiple Document Permission resources

        get
        https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid_like<IS> Not PII

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

        document_sid
        Path
        get sid_like<ET> Not PII

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

        Example 1
              
              
              
              

              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.

              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.

              Parameters
              Parameters in REST API format
              service_sid
              Path
              post sid_like<IS> Not PII

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

              document_sid
              Path
              post sid_like<ET> Not PII

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

              identity
              Path
              post string PII MTL: 30 DAYS

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

              read
              Required
              post boolean Not PII

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

              write
              Required
              post boolean Not PII

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

              manage
              Required
              post boolean Not PII

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

              Example 1
                    
                    
                    
                    

                    Delete a Document Permission resource

                    delete
                    https://sync.twilio.com/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}
                    Parameters
                    Parameters in REST API format
                    service_sid
                    Path
                    delete sid_like<IS> Not PII

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

                    document_sid
                    Path
                    delete sid_like<ET> Not PII

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

                    identity
                    Path
                    delete string PII MTL: 30 DAYS

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

                    Example 1
                          
                          
                          
                          
                          Rate this page:

                          Need some help?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.