Skip to main content
GET
List book access for a user.

Authorizations

Authorization
string
header
required

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

Query Parameters

organisationUserEmail
string

The required email address of an active Risk Portal user in the caller's organisation; for example, analyst@example.test.

Response

Returns the user's accessible Derivitec books and access levels, or an unsuccessful envelope for administrator, membership, or target-user failures.

Books explicitly assigned to the selected organisation user.

$type
enum<string>
required
Available options:
Derivitec.Web.Core.BookAccess.ApiProxyUserBookAccessGetResponse, 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_accesses
object[] | null

Books explicitly assigned to the selected user, with source and assigned level.