Skip to main content
POST
List users with access to a book.

Authorizations

Authorization
string
header
required

OAuth2 access-token requested from AWS Cognito and provided as a Auth Bearer header

Body

Required BookName for a book available to the caller.

Book selection for listing the users who can access it.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.BookAccess.ApiListBookAccessorsRequest, Derivitec.Web.Core
book_name
string | null

Organisation-scoped name of the book to select. The value must not be null or empty.

Example:

"Example book"

Response

Returns accessor names and access levels, or an unsuccessful envelope when the book is unavailable or the caller is not its owner.

Users and access levels recorded for the selected book.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.BookAccess.ApiListBookAccessorsResponse, Derivitec.Web.Core
is_success
boolean

Whether the operation completed successfully. The default is true; error outcomes set it to false.

Example:

true

error_messages
string[] | null

Messages explaining operation-level failures. The collection is empty by default.

book_accessors
object[] | null

Users recorded as having access to the selected book and each user's assigned level.