OMomniapp
Documents

List document access principals

Changed on
get/api/v1/documents/{identifier}/access-list

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/documents/{identifier}/access-list
  • Auth
    HTTP bearer

Path parameters

identifierstring required

Document identifier (either document ID or identifier slug)

Example:abc123

Query parameters

cursorstring

Cursor for pagination (from previous response nextCursor)

Example:eyJpZCI6IjEyMzQ1In0
pageSizeinteger

Number of results per page (1-100, integer)

Example:20
sortDirection'asc' | 'desc'

Sort direction (default: asc)

Example:desc
sortFieldstring

Field to sort results by

accessSource'direct' | 'folder'

Filter by access source: direct or folder

type'user' | 'userGroup'

Filter by principal type: user or userGroup

Response

List of users and groups with access

Changes

  • dfcc576cd5f8Revision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      response property principals/items/oneOf[GroupAccessPrincipal]/id deprecated

    • info

      response property principals/items/oneOf[UserAccessPrincipal]/id deprecated

  • c24bde3d4aa3Revision changes
    • breaking

      added to the / response property oneOf list for the response status

    • info

      added discriminator to / response property for the response status