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

# List provisioned users



## OpenAPI

````yaml https://eris.devops.truu.ai/api/v1/external/docs get /users
openapi: 3.0.3
info:
  title: TOTAL Public API
  version: 2.3.10
  description: >
    The TOTAL API gives you programmatic access to your organization's

    security data. Use it to query cases and threat events, and to feed

    verdicts back into the platform.


    ## Authentication


    All routes in this specification are served under `/api/v1/external` and

    require a domain-scoped API key via the `X-API-Key` header. Generate and

    manage keys from the API Keys page in Settings.


    The admin console (Atlas) uses separate JWT-authenticated routes under

    `/api/v1/eris/...` (for example `GET /api/v1/eris/integrations`); those are

    not part of this public API surface.


    ## Pagination

    List routes use cursor pagination: `page_size` (default 50, max 200) and

    optional `next_cursor` (pass the `case_id` or `event_id` UUID from the last

    item of the previous page). Responses include `next_cursor` when more

    results are available.


    ## Rate Limits

    Read endpoints in this API are limited to 1,000 requests/minute.

    Write endpoints in this API are limited to 200 requests/minute.


    ## Availability

    Some routes may return `423 Locked` when the requested data is not yet

    available for your domain.


    ---


    ## Appendix A — Azure Log Analytics: source_event_ids → KQL lookup


    Threat events include a `source_event_ids` array. Each value is the

    `_ItemId` of the originating row in your Azure Log Analytics workspace

    — the per-row GUID stamped by Log Analytics at ingest. It is row-unique

    on every supported table, so the same lookup pattern works regardless

    of source:

        <SourceTable> | where _ItemId == "<id>"

    Run the lookup against your Log Analytics workspace (the same workspace

    that backs Azure Log Analytics / Defender XDR Advanced Hunting). Use the

    `source` field on the event to pick the table.


    | Source table | KQL field | Example KQL |

    |---|---|---|

    | SigninLogs | _ItemId | `SigninLogs | where _ItemId == "<id>"` |

    | AuditLogs | _ItemId | `AuditLogs | where _ItemId == "<id>"` |

    | AADUserRiskEvents | _ItemId | `AADUserRiskEvents | where _ItemId ==
    "<id>"` |

    | CloudAppEvents | _ItemId | `CloudAppEvents | where _ItemId == "<id>"` |

    | OfficeActivity | _ItemId | `OfficeActivity | where _ItemId == "<id>"` |

    | EmailEvents | _ItemId | `EmailEvents | where _ItemId == "<id>"` |

    | EmailPostDeliveryEvents | _ItemId | `EmailPostDeliveryEvents | where
    _ItemId == "<id>"` |

    | EmailUrlInfo | _ItemId | `EmailUrlInfo | where _ItemId == "<id>"` |

    | EmailAttachmentInfo | _ItemId | `EmailAttachmentInfo | where _ItemId ==
    "<id>"` |

    | UrlClickEvents | _ItemId | `UrlClickEvents | where _ItemId == "<id>"` |

    | SecurityEvent | _ItemId | `SecurityEvent | where _ItemId == "<id>"` |

    | IdentityLogonEvents | _ItemId | `IdentityLogonEvents | where _ItemId ==
    "<id>"` |

    | IdentityQueryEvents | _ItemId | `IdentityQueryEvents | where _ItemId ==
    "<id>"` |

    | IdentityDirectoryEvents | _ItemId | `IdentityDirectoryEvents | where
    _ItemId == "<id>"` |

    | BehaviorAnalytics | _ItemId | `BehaviorAnalytics | where _ItemId ==
    "<id>"` |

    | Anomalies | _ItemId | `Anomalies | where _ItemId == "<id>"` |

    | AzureActivity | _ItemId | `AzureActivity | where _ItemId == "<id>"` |

    | MicrosoftPurviewInformationProtection | _ItemId |
    `MicrosoftPurviewInformationProtection | where _ItemId == "<id>"` |

    | CommonSecurityLog | _ItemId | `CommonSecurityLog | where _ItemId ==
    "<id>"` |

    | Syslog | _ItemId | `Syslog | where _ItemId == "<id>"` |

    | AADProvisioningLogs | _ItemId | `AADProvisioningLogs | where _ItemId ==
    "<id>"` |
servers:
  - url: https://eris.devops.truu.ai/api/v1/external
    description: TOTAL Public API
security:
  - ApiKeyAuth: []
tags:
  - name: Cases
    description: Threat investigation cases and verdicts
  - name: Users
    description: Provisioned users and monitoring
  - name: Personas
    description: Persona overviews
  - name: Threats
    description: Raw threat events
paths:
  /users:
    get:
      tags:
        - Users
      summary: List provisioned users
      operationId: listUsers
      parameters:
        - name: search
          in: query
          schema:
            type: string
          description: Filter by name or UPN (partial match)
        - name: is_active
          in: query
          schema:
            type: boolean
        - name: page_size
          in: query
          schema:
            type: integer
            default: 50
            maximum: 200
        - name: next_cursor
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Paginated list of users
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CursorPage'
                  - type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/UserListItem'
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CursorPage:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
    UserListItem:
      type: object
      properties:
        tuid:
          type: string
          format: uuid
        domain_id:
          type: string
          format: uuid
        external_id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        user_principal_name:
          type: string
          nullable: true
        email_addresses:
          type: array
          items:
            type: string
        group_guid:
          type: string
          format: uuid
        is_active:
          type: boolean
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: |
        Domain-scoped API key. Generate and manage keys from the API Keys
        page in Settings.

        Accepted in two forms:
        - `X-API-Key: <key>` header (preferred)
        - `Authorization: Bearer <key>` header (also accepted)

````