> ## Documentation Index
> Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add book access for a user.

> Use an administrator account to grant another active user in the same organisation access to a book the
caller can access. A view-only target can receive only `View` access. A matching-name book already
linked to the target, or an identical existing grant, is rejected. The grant is applied before returning in
the normal result envelope.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json post /api/BookAccess/Create
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/BookAccess/Create:
    post:
      tags:
        - BookAccess
      summary: Add book access for a user.
      description: >-
        Use an administrator account to grant another active user in the same
        organisation access to a book the

        caller can access. A view-only target can receive only `View` access. A
        matching-name book already

        linked to the target, or an identical existing grant, is rejected. The
        grant is applied before returning in

        the normal result envelope.
      operationId: Create
      requestBody:
        description: >-
          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).
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ApiProxyUserBookAccessCreateRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/ApiProxyUserBookAccessCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ApiProxyUserBookAccessCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ApiProxyUserBookAccessCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiProxyUserBookAccessCreateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiProxyUserBookAccessCreateRequest:
      required:
        - $type
      type: object
      properties:
        proxy_user_email:
          type: string
          description: >-
            Email address of the organisation user whose book access is being
            changed.
          nullable: true
          example: user@example.com
        book_name:
          type: string
          description: >-
            Organisation-scoped name of the book to select. The value must not
            be null or empty.
          nullable: true
          example: Example book
        access_type:
          enum:
            - view
            - edit
            - full
            - owner
          type: string
          description: Book access level to grant to the selected user.
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.BookAccess.ApiProxyUserBookAccessCreateRequest,
              Derivitec.Web.Core
      additionalProperties: false
      description: Target user, book, and access level selected for a new book grant.
    ApiProxyUserBookAccessCreateResponse:
      required:
        - $type
      type: object
      additionalProperties: false
      description: Outcome of granting a user access to a book.
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.BookAccess.ApiProxyUserBookAccessCreateResponse,
              Derivitec.Web.Core
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: false
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````