Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-054815267.9 KB
SyncV1DocumentPermission

Update an identity's access to a specific Sync Document.

Update an identity's access to a specific Sync Document.

post/v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}

Path parameters

ServiceSidstring required

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

DocumentSidstring required

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

Identitystring required

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

Response

OK

account_sidstring nullable

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

service_sidstring nullable

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

document_sidstring nullable

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

identitystring nullable

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

readboolean nullable

Whether the identity can read the Sync Document.

writeboolean nullable

Whether the identity can update the Sync Document.

manageboolean nullable

Whether the identity can delete the Sync Document.

urlstring uri nullable

The absolute URL of the Sync Document Permission resource.