Skip to main content
POST
Remove book access from 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, and AccessType to remove: View, Edit, Full, or Owner.

Target user, book, and access level selected for removal.

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

Existing book access level to remove from the selected user.

Available options:
view,
edit,
full,
owner

Response

Returns whether access was removed and target-user, book, or permission errors in the normal response envelope.

Outcome of removing a user's stated book access.

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