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

# Replace a permission set's grants and description.

> `permissions` is the complete new list, not a delta — anything you omit is
removed. Every member of this organization assigned to the set has their
effective permissions re-materialised as part of the request, so the change
takes effect on those users' next call rather than after a cache expiry.

Builtin sets (`read-only`, `standard`, `admin`) are immutable and refuse the
write with 409, so those names always mean the same thing.

Note the asymmetry: writing a set needs `settings:write`, while reading one
needs `users:read`.



## OpenAPI

````yaml /reference/openapi.json put /permission-sets/{name}
openapi: 3.1.0
info:
  title: AgentEye API
  description: >-
    The AgentEye observability API.


    Every path below is relative to `/v1` on your deployment's dashboard origin
    — e.g. `https://app.example.com/v1/sessions`. Authenticate with a scoped API
    key as a bearer token.


    Organization scoping: a key belongs to one organization and acts on it
    automatically. An instance-scoped key selects one per request with the
    `X-AgentEye-Org` header; without it, such a key resolves to the default
    organization, so set it explicitly on a multi-org deployment.
  license:
    name: MIT
    identifier: MIT
  version: 0.0.1-beta.77
servers:
  - url: /v1
    description: This deployment
security:
  - api_key: []
tags:
  - name: Events
    description: Ingest and query the event store.
  - name: Sessions
    description: Agent sessions and their evaluations.
  - name: Evaluations
    description: Evaluation results and re-runs.
  - name: Dashboards
    description: Dashboards and their tiles.
  - name: Queries
    description: Saved SQL and ad-hoc query execution.
  - name: Keys
    description: Mint and manage scoped API keys.
  - name: Users
    description: Dashboard members and access.
  - name: Settings
    description: Operational settings and context-window overrides.
  - name: Permission sets
    description: Named permission roles.
  - name: Alerts
    description: Alert rules and their recipients.
  - name: Issues
    description: Open, triage, assign and resolve issues.
  - name: Audits
    description: Recurring audits and their findings.
  - name: Usage
    description: Organization usage and billing windows.
  - name: Health
    description: Liveness.
  - name: Auth
    description: Describe the key you are calling with.
paths:
  /permission-sets/{name}:
    put:
      tags:
        - Permission sets
      summary: Replace a permission set's grants and description.
      description: >-
        `permissions` is the complete new list, not a delta — anything you omit
        is

        removed. Every member of this organization assigned to the set has their

        effective permissions re-materialised as part of the request, so the
        change

        takes effect on those users' next call rather than after a cache expiry.


        Builtin sets (`read-only`, `standard`, `admin`) are immutable and refuse
        the

        write with 409, so those names always mean the same thing.


        Note the asymmetry: writing a set needs `settings:write`, while reading
        one

        needs `users:read`.
      operationId: update_permission_set
      parameters:
        - name: name
          in: path
          description: The permission set's name.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePermissionSetRequest'
        required: true
      responses:
        '200':
          description: The updated set.
        '401':
          description: Missing, unknown, or disabled key.
        '403':
          description: The key lacks `settings:write`.
        '404':
          description: No set by that name in this organization.
        '409':
          description: Builtin permission sets are immutable.
        '422':
          description: >-
            The name is empty or over 64 characters, or a permission is unknown
            or duplicated.
      security:
        - api_key: []
components:
  schemas:
    UpdatePermissionSetRequest:
      type: object
      required:
        - permissions
      properties:
        description:
          type:
            - string
            - 'null'
        permissions:
          type: array
          items:
            type: string
          description: >-
            The full new list of grants — this replaces the set's permissions,
            it is

            not a delta. Every entry must be a known permission, with no
            duplicates.
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
      description: >-
        A scoped AgentEye API key. Mint one in the dashboard under Settings →
        API keys, or with `POST /v1/keys`. Each endpoint names the permission it
        requires; a key without it gets 403 and a `required_permission` field
        naming what was missing.

````