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

# Agent Rollout Invite

> Invite/notify the workforce to install the desktop agent (DLP rollout).

A new email address gets a real account invitation whose email also carries the
agent download link + install guide. Someone who already has an account in this
workspace gets an install nudge instead (no second account). ``all_users`` expands
to every active user in the caller's workspace.



## OpenAPI

````yaml /api-reference/openapi.json post /api/invitations/agent-rollout
openapi: 3.1.0
info:
  title: Blindsight API
  version: 0.1.0
  description: >-
    The full Blindsight REST surface, generated from the running application.
    Replace the server host with your own deployment.


    For the Runtime Security integration surface (scan, proxy, tool calls) see
    the Runtime Security spec, which is hand written and carries worked
    examples.
servers:
  - url: https://api.your-blindsight.com
    description: Your Blindsight deployment
security: []
paths:
  /api/invitations/agent-rollout:
    post:
      tags:
        - invitations
      summary: Agent Rollout Invite
      description: >-
        Invite/notify the workforce to install the desktop agent (DLP rollout).


        A new email address gets a real account invitation whose email also
        carries the

        agent download link + install guide. Someone who already has an account
        in this

        workspace gets an install nudge instead (no second account).
        ``all_users`` expands

        to every active user in the caller's workspace.
      operationId: agent_rollout_invite_api_invitations_agent_rollout_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentRolloutRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentRolloutResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AgentRolloutRequest:
      properties:
        emails:
          items:
            type: string
          type: array
          title: Emails
          default: []
        all_users:
          type: boolean
          title: All Users
          default: false
        roles:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Roles
        expires_hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Expires Hours
      type: object
      title: AgentRolloutRequest
    AgentRolloutResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/AgentRolloutResultEntry'
          type: array
          title: Results
        invited:
          type: integer
          title: Invited
          default: 0
        notified:
          type: integer
          title: Notified
          default: 0
        skipped:
          type: integer
          title: Skipped
          default: 0
        errors:
          type: integer
          title: Errors
          default: 0
      type: object
      required:
        - results
      title: AgentRolloutResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AgentRolloutResultEntry:
      properties:
        email:
          type: string
          title: Email
        status:
          type: string
          title: Status
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
        invite_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Invite Id
      type: object
      required:
        - email
        - status
      title: AgentRolloutResultEntry
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````