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

# Search Principals

> Search for users and service accounts that can be assigned roles.

Use this to look up principals by email or name before creating role bindings.


## OpenAPI

````yaml GET /api/v1/access-control/principals
openapi: 3.1.0
info:
  title: Rigbox Public API
  description: >-
    Gateway-owned public API for Rigbox. The gateway composes its local
    lifecycle API with service-owned exported specs.
  contact:
    name: Rigbox
    url: https://rigbox.dev
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.rigbox.dev
    description: Production gateway
security: []
tags:
  - name: Workspaces
  - name: CLI
  - name: Observability
  - name: Auth
  - name: API Keys
  - name: Access Control
  - name: Apps
  - name: App Catalog
  - name: Logs
  - name: AI
  - name: Tools
  - name: Snapshots
  - name: SSH Keys
  - name: Templates
  - name: Setup Scripts
  - name: Service Specs
  - name: Deploy
  - name: Community
  - name: User Settings
  - name: Roadmap
  - name: System
paths:
  /api/v1/access-control/principals:
    get:
      tags:
        - Access Control
      summary: List principals.
      description: >-
        List the principals on your account that can be granted access-control
        roles.
      operationId: search_principals
      parameters:
        - name: resource
          in: query
          description: Canonical resource ref
          required: true
          schema:
            type: string
        - name: query
          in: query
          description: Email or display-name search text
          required: true
          schema:
            type: string
        - name: limit
          in: query
          description: Optional result limit
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: Principals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrincipalLookupResponse'
      security:
        - bearer: []
components:
  schemas:
    PrincipalLookupResponse:
      type: object
      required:
        - principals
      properties:
        principals:
          type: array
          items:
            $ref: '#/components/schemas/PrincipalLookupResult'
    PrincipalLookupResult:
      type: object
      required:
        - principal
        - user_id
        - email
      properties:
        display_name:
          type:
            - string
            - 'null'
        email:
          type: string
        principal:
          type: string
        user_id:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````