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

# Access object reference

> Full per-resource schema for the access object returned by get_identity and get_role: scope, description, and saved views with their sharing roster.

The `access` object carries one key **per resource the caller can actually
reach** (`statement`, `request`, `quota`, `data_table`, `report`,
`dashboard`). Each key holds how broadly the caller sees that resource
(`scope` plus a plain-language `description`) and, for statements and
requests, the saved `views` they may pass to the matching list tool. A
resource the caller has no access to carries **no key at all** — if a key is
missing, do not try to query that resource.

Reports and dashboards report `all` or `shared` only, like quotas: each *is*
its own view, so a share names the resource itself. A caller who reaches a
report **only** through a shared dashboard carries no `report` key — the
values its tiles display are named in that dashboard's `description` instead
of inventing a fifth `scope`.

Referenced from: [`get_identity`](/mcp_documentation/tools/get_identity),
[`get_role`](/mcp_documentation/tools/get_role).

## Shape

<ResponseField name="statement" type="object">
  <Expandable title="object properties">
    <ResponseField name="scope" type="string">
      One of: `all`, `users_below`, `me`, `shared`.
    </ResponseField>

    <ResponseField name="description" type="string">
      Plain-language sentence about what this scope actually lets you
      reach for this resource, meant to be read as-is.
    </ResponseField>

    <ResponseField name="views" type="object[]">
      The saved views you may pass as the `view_id` argument of this
      resource's list tool. Full schema, shared identically across
      `statement`, `request`, `quota` and `data_table`:
      [Access views reference](/mcp_documentation/reference/access_views).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="request" type="object">
  <Expandable title="object properties">
    <ResponseField name="scope" type="string">
      One of: `all`, `users_below`, `me`, `shared`.
    </ResponseField>

    <ResponseField name="description" type="string">
      Plain-language sentence about what this scope actually lets you
      reach for this resource, meant to be read as-is.
    </ResponseField>

    <ResponseField name="views" type="object[]">
      Same shape as `statement.views` above.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="quota" type="object">
  <Expandable title="object properties">
    <ResponseField name="scope" type="string">
      One of: `all`, `users_below`, `me`, `shared`.
    </ResponseField>

    <ResponseField name="description" type="string">
      Plain-language sentence about what this scope actually lets you
      reach for this resource, meant to be read as-is.
    </ResponseField>

    <ResponseField name="views" type="object[]">
      Same shape as `statement.views` above.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="data_table" type="object">
  <Expandable title="object properties">
    <ResponseField name="scope" type="string">
      One of: `all`, `users_below`, `me`, `shared`.
    </ResponseField>

    <ResponseField name="description" type="string">
      Plain-language sentence about what this scope actually lets you
      reach for this resource, meant to be read as-is.
    </ResponseField>

    <ResponseField name="views" type="object[]">
      Same shape as `statement.views` above.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="report" type="object">
  <Expandable title="object properties">
    <ResponseField name="scope" type="string">
      One of: `all`, `shared`. Reports are advertised only when the
      company has reporting enabled; a caller with no report reach at all
      carries no `report` key. A caller who reaches a report only through
      a shared dashboard likewise carries no key here — read the tile
      values named in that dashboard's `description` instead.
    </ResponseField>

    <ResponseField name="description" type="string">
      Plain-language sentence about what this scope actually lets you
      reach for this resource, meant to be read as-is.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="dashboard" type="object">
  <Expandable title="object properties">
    <ResponseField name="scope" type="string">
      One of: `all`, `shared`. Dashboards are advertised only when the
      company has reporting enabled.
    </ResponseField>

    <ResponseField name="description" type="string">
      Plain-language sentence about what this scope actually lets you
      reach for this resource, meant to be read as-is. For a caller who
      has no `report` entry of their own, this description also names the
      report tools they may still call for the values these dashboards
      display — `get_report_chart_data` for a charted report,
      `get_report_pivot_data` for a pivoted one — but never the report
      rows or its configuration.
    </ResponseField>
  </Expandable>
</ResponseField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.