The Sync List 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 Sync List Permission resource is the same as setting all permissions to false
.
account_sid
type: SID<AC>The SID of the Account that created the Sync List 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
list_sid
type: SID<ES>The SID of the Sync List to which the Permission applies.
^ES[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.
write
type: booleanWhether the identity can create, update, and delete Items in the Sync List.
GET https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
ServiceSid
type: stringThe SID of the Sync Service with the Sync List Permission resource to fetch.
ListSid
type: stringThe SID of the Sync List with the Sync List Permission resource to fetch. Can be the Sync List resource's sid
or its unique_name
.
Identity
type: stringThe application-defined string that uniquely identifies the User's Sync List Permission resource to fetch.
GET https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions
ServiceSid
type: stringThe SID of the Sync Service with the Sync List Permission resources to read.
ListSid
type: stringThe SID of the Sync List with the Sync List Permission resources to read. Can be the Sync List 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}/Lists/{ListSid}/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 Sync List Permission resource to update.
ListSid
type: stringThe SID of the Sync List with the Sync List Permission resource to update. Can be the Sync List resource's sid
or its unique_name
.
Identity
type: stringThe application-defined string that uniquely identifies the User's Sync List Permission resource to update.
Read
type: booleanRequiredWhether the identity can read the Sync List and its Items. Default value is false
.
Write
type: booleanRequiredWhether the identity can create, update, and delete Items in the Sync List. Default value is false
.
Manage
type: booleanRequiredWhether the identity can delete the Sync List. Default value is false
.
DELETE https://sync.twilio.com/v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}
ServiceSid
type: stringThe SID of the Sync Service with the Sync List Permission resource to delete.
ListSid
type: stringThe SID of the Sync List with the Sync List Permission resource to delete. Can be the Sync List resource's sid
or its unique_name
.
Identity
type: stringThe application-defined string that uniquely identifies the User's Sync List Permission resource to delete.