Skip to main content
POST
Add book access for a user.

Authorizations

Authorization
string
header
required

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

Body

Required ProxyUserEmail for another active same-organisation user, BookName for a book available to the caller, and AccessType: View (1), Edit (2), Full (3), or Owner (4).

Target user, book, and access level selected for a new book grant.

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

Email address of the organisation user whose book access is being changed.

Example:

"user@example.com"

book_name
string | null

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

Example:

"Example book"

access_type
enum<string>

Book access level to grant to the selected user.

Available options:
view,
edit,
full,
owner

Response

Created

Outcome of granting a user access to a book.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.BookAccess.ApiProxyUserBookAccessCreateResponse, 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.