Sync Map Permission Resource
The Sync Map 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 aSync Map Permission resource is the same as setting all permissions to false.
Sync Map Permission properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that created the Sync Map Permission resource. |
service_sid
|
The SID of the Sync Service the resource is associated with. |
map_sid
|
The SID of the Sync Map to which the Permission applies. |
identity
|
The application-defined string that uniquely identifies the resource's User within the Service to an FPA token. |
read
|
Whether the identity can read the Sync Map and its Items. |
write
|
Whether the identity can create, update, and delete Items in the Sync Map. |
manage
|
Whether the identity can delete the Sync Map. |
url
|
The absolute URL of the Sync Map Permission resource. |
Fetch a Sync Map Permission resource
https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Sync Service with the Sync Map Permission resource to fetch. Can be the Service's |
map_sid
Path
|
The SID of the Sync Map with the Sync Map Permission resource to fetch. Can be the Sync Map resource's |
identity
Path
|
The application-defined string that uniquely identifies the User's Sync Map Permission resource to fetch. |
Example 1
Read multiple Sync Map Permission resources
https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Sync Service with the Sync Map Permission resources to read. Can be the Service's |
map_sid
Path
|
The SID of the Sync Map with the Permission resources to read. Can be the Sync Map resource's |
Example 1
Update a Sync Map Permission resource
https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
Updates the permissions of the sync map 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
|
The SID of the Sync Service with the Sync Map Permission resource to update. Can be the Service's |
map_sid
Path
|
The SID of the Sync Map with the Sync Map Permission resource to update. Can be the Sync Map resource's |
identity
Path
|
The application-defined string that uniquely identifies the User's Sync Map Permission resource to update. |
read
Required
|
Whether the identity can read the Sync Map and its Items. Default value is |
write
Required
|
Whether the identity can create, update, and delete Items in the Sync Map. Default value is |
manage
Required
|
Whether the identity can delete the Sync Map. Default value is |
Example 1
Delete a Sync Map Permission resource
https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}
Parameters
| Parameters in REST API format | |
|---|---|
service_sid
Path
|
The SID of the Sync Service with the Sync Map Permission resource to delete. Can be the Service's |
map_sid
Path
|
The SID of the Sync Map with the Sync Map Permission resource to delete. Can be the Sync Map resource's |
identity
Path
|
The application-defined string that uniquely identifies the User's Sync Map Permission resource to delete. |
Example 1
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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
