Path parameters

• ServiceSid string Required

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

• DocumentSid string Required

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

Query parameters

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 100.

  Minimum value is 1, maximum value is 100.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • permissions array[object]
    Hide permissions attributes Show permissions attributes object

    • account_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • service_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • document_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ET[0-9a-fA-F]{32}$.

    • identity string | null

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

    • read boolean | null

      Whether the identity can read the Sync Document.

    • write boolean | null

      Whether the identity can update the Sync Document.

    • manage boolean | null

      Whether the identity can delete the Sync Document.

    • url string(uri) | null

      The absolute URL of the Sync Document Permission resource.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)