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

# Propose granting or revoking an agent's authority

> Proposes per-agent authority (RFC-0023 phase 3): `grant` says the API key with `callerId` may have requests for `capability` decided, within `limits` on the request, until `validUntil` (at most 366 days); `revoke` ends the active grant.



## OpenAPI

````yaml openapi.bundled.yaml POST /authority-grants/changes
openapi: 3.1.0
info:
  title: Parmana API
  version: 1.0.0
  description: >
    Parmana sits between an AI agent and the systems it acts on. An agent sends
    a Business Transaction: who

    authorized it, what action it wants, and the facts that justify it. Parmana
    evaluates the policy bound to

    the action, checks any signed human approval the policy requires, releases
    the action to the connector

    only if the policy approves, and returns a signed Execution Trust Record
    anyone can verify.


    **Authentication.** Send `Authorization: Bearer <key>` on every request. The
    only routes that need no key

    are the probes, the documents and the independent verification routes: `GET
    /health`, `GET /ready`,

    `GET /openapi.yaml`, `GET /openapi.json`, `GET /api-manifest.json`, `GET
    /documentation`,

    `GET /reference`, `GET /parmana-handbook.pdf`, `GET
    /handbook/download-leads`,

    `POST /handbook/download-leads`, `POST /refusal/verify`, `POST
    /execution-intents/verify`,

    `POST /audit/verify`, `GET /keys/{keyId}` and `GET /.well-known/jwks.json`.
    A missing or unknown key

    returns `401` before anything else runs. The server holds only a hash of
    each key. See

    [Authentication](/api-reference/authentication).


    **Two kinds of key.** An agent or service key may invoke only the
    capabilities listed on it. A human key

    (`credentialHolderType: USER`) is required for governance: proposing and
    approving policies, approvers

    and external connectors, and repairing Execution Intents. Approving or
    rejecting a change also needs a

    step up authorization signed with the checker's own step up key, and the
    checker must not be the

    person who proposed it.


    **Ownership.** Every lookup by `businessTransactionId` is scoped to the key
    that submitted the

    transaction. A transaction submitted by another key returns the same `404`
    as one that does not exist.


    **Try it live.** The first server below is the public sandbox,
    `https://parmana-sandbox.vercel.app`: the same

    code as production with its own database, keys and demo approver, whose one
    action, `sandbox:receipt`,

    acts on nothing. Every "Try it" panel calls it with the published demo key
    prefilled. The demo key may

    invoke only `sandbox:receipt`, so other capabilities return `403` and
    governance routes return

    `403 NON_HUMAN_CALLER_DENIED`. Everything sent to the sandbox is visible to
    every visitor. See

    [Playground](/playground). Production needs a key issued by its operator.


    **Start here:** the [Playground](/playground) (no install), the
    [Quickstart](/quickstart), then [Integrate Parmana](/agents/integrate) for
    agents

    and [Connect any external system](/guides/connect-any-external-system) for
    your own endpoint.
  contact:
    name: Parmana Systems
    email: founder@parmanasystems.com
  license:
    name: Proprietary, source-available for evaluation only, see LICENSE
    url: https://github.com/pavancharak/parmana/blob/main/LICENSE
servers:
  - url: https://parmana-sandbox.vercel.app
    description: >-
      Public sandbox (the docs playground). Same code as production, demo data
      only, acts on nothing. Demo key prefilled.
  - url: https://parmana-api-real.vercel.app
    description: Production. Needs a key issued by the operator.
  - url: http://localhost:3000
    description: Local (packages/api, PORT env var, default 3000)
security:
  - bearerAuth: []
tags:
  - name: Execution
    description: >-
      Executes a Business Transaction through the complete Execution Trust
      pipeline
  - name: Transactions
    description: Business Transaction creation and retrieval
  - name: Verification
    description: Deterministic verification of an Execution Trust Record
  - name: Receipts
    description: Cryptographically signed Execution Trust Receipts
  - name: Trust Records
    description: Execution Trust Record retrieval
  - name: Replay
    description: Deterministic replay of a recorded Execution Trust Record
  - name: Policies
    description: Policy existence/readability check
  - name: Policy Governance
    description: Maker-checker proposal, listing, approval, and rejection of policy changes
  - name: Approvers
    description: Maker-checker for the keys trusted to sign approvals, without a deploy
  - name: External Connectors
    description: >-
      Maker-checker for binding a capability to an operator's HTTPS endpoint and
      its policy, without a deploy (ADR-0013)
  - name: Business Signal Sources
    description: >-
      Maker-checker for the business systems Parmana asks for the facts a policy
      needs, without a deploy (RFC-0023)
  - name: Authority Grants
    description: >-
      Maker-checker for which agent may have which action decided, within which
      limits, until when (RFC-0023)
  - name: Sandbox
    description: >-
      Routes that exist only on the public sandbox (ADR-0014), for trying
      Parmana from a browser
  - name: Refusal Records
    description: >-
      Durable, signed evidence that a policy decision rejected a transaction
      (RFC-0021)
  - name: Execution Intents
    description: >-
      A signed statement, stored before an action is released, of exactly what
      is about to be released, plus the operator tools to find and repair a
      released action that has no signed Trust Record (ADR-0012)
  - name: Audit
    description: >-
      Signed caller-authentication audit events, independently
      third-party-verifiable
  - name: System
    description: Operational endpoints
paths:
  /authority-grants/changes:
    post:
      tags:
        - Authority Grants
      summary: Propose granting or revoking an agent's authority
      description: >
        Proposes per-agent authority (RFC-0023 phase 3): `grant` says the API
        key with `callerId` may have

        requests for `capability` decided, within `limits` on the request, until
        `validUntil` (at most 366

        days); `revoke` ends the active grant. Nothing changes until a different
        person approves it. You

        may not propose authority for your own key. Under a policy with
        `requireAuthorityGrant`, a request

        from a key with no grant in force, or outside its limits, is refused as
        `NOT_AUTHORIZED`, and one

        after `validUntil` as `AUTHORITY_EXPIRED`. To change a grant, revoke it,
        then grant again. Needs a

        human key.
      operationId: proposeAuthorityGrantChange
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/propose-authority-grant-change-request.schema
            examples:
              grant:
                summary: Real captured request
                value:
                  action: grant
                  callerId: warehouse-agent
                  capability: erp:release-goods
                  limits:
                    parameters.amount:
                      max: 100000
                    parameters.currency:
                      oneOf:
                        - INR
                  validUntil: '2026-12-30T00:00:00.000Z'
                  reason: >-
                    The warehouse agent releases goods for paid invoices up to
                    100000 INR this quarter.
              revoke:
                summary: Real captured request
                value:
                  action: revoke
                  callerId: warehouse-agent
                  capability: erp:release-goods
                  reason: The warehouse agent's key is being rotated.
      responses:
        '201':
          description: Proposed and waiting for a checker. Keep the `changeId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/authority-grant-change-response.schema'
              examples:
                grant:
                  summary: Real captured response
                  value:
                    changeId: 9f3cf733-a8ed-487c-bb58-a53950388cdf
                    action: grant
                    callerId: warehouse-agent
                    capability: erp:release-goods
                    limits:
                      parameters.amount:
                        max: 100000
                      parameters.currency:
                        oneOf:
                          - INR
                    validUntil: '2026-12-30T00:00:00.000Z'
                    reason: >-
                      The warehouse agent releases goods for paid invoices up to
                      100000 INR this quarter.
                    proposedBy: grant-maker
                    proposedAt: '2026-10-11T03:29:05.220Z'
                    status: PENDING_APPROVAL
                revoke:
                  summary: Real captured response
                  value:
                    changeId: c7955228-f718-4f21-8ac9-c48ce907b91a
                    action: revoke
                    callerId: warehouse-agent
                    capability: erp:release-goods
                    reason: The warehouse agent's key is being rotated.
                    proposedBy: grant-maker
                    proposedAt: '2026-10-11T03:29:05.283Z'
                    status: PENDING_APPROVAL
        '400':
          description: >-
            `INVALID_AUTHORITY_GRANT`: a field is missing or malformed, a limit
            is malformed, validUntil is missing, past, before validFrom or more
            than 366 days away, or a revoke carries grant fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.schema'
              examples:
                badCapability:
                  summary: Real captured response
                  value:
                    error: >-
                      capability must be namespace:verb, at most 128 characters,
                      matching
                      ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*:[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$.
                    code: INVALID_AUTHORITY_GRANT
                badLimitPath:
                  summary: Real captured response
                  value:
                    error: limits key 'amount' must be target or parameters.<name>.
                    code: INVALID_AUTHORITY_GRANT
                badLimit:
                  summary: Real captured response
                  value:
                    error: limits['parameters.amount'].min must not be above its max.
                    code: INVALID_AUTHORITY_GRANT
                noExpiry:
                  summary: Real captured response
                  value:
                    error: validUntil must be an ISO 8601 date and time.
                    code: INVALID_AUTHORITY_GRANT
                tooLong:
                  summary: Real captured response
                  value:
                    error: >-
                      A grant may last at most 366 days. Grant again when it
                      ends.
                    code: INVALID_AUTHORITY_GRANT
                revokeWithGrantFields:
                  summary: Real captured response
                  value:
                    error: >-
                      A revoke takes only action, callerId, capability and
                      reason.
                    code: INVALID_AUTHORITY_GRANT
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            `NON_HUMAN_CALLER_DENIED`: this needs a human key.
            `AUTHORITY_SELF_GRANT_DENIED`: the grant is for your own key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.schema'
              examples:
                service:
                  summary: Real captured response, a service credential
                  value:
                    error: >-
                      This action requires a caller credential provisioned as a
                      verified human (credentialHolderType: USER).
                    code: NON_HUMAN_CALLER_DENIED
                selfGrant:
                  summary: Real captured response
                  value:
                    error: >-
                      'grant-maker' may not propose, approve or reject authority
                      for itself.
                    code: AUTHORITY_SELF_GRANT_DENIED
        '409':
          description: >-
            `CONFLICT`: the caller already holds a grant for the capability (to
            grant) or holds none (to revoke), or another change for it is
            pending.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.schema'
              examples:
                pending:
                  summary: Real captured response
                  value:
                    error: >-
                      A change for the authority of 'warehouse-agent' over
                      'erp:release-goods' is already pending. It must be
                      approved or rejected first.
                    code: CONFLICT
                alreadyActive:
                  summary: Real captured response
                  value:
                    error: >-
                      'warehouse-agent' already holds a grant for
                      'erp:release-goods'. Revoke it first.
                    code: CONFLICT
                revokeUnknown:
                  summary: Real captured response
                  value:
                    error: '''x-agent'' holds no grant for ''erp:release-goods''.'
                    code: CONFLICT
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            https://parmana-api-real.vercel.app/authority-grants/changes \
              -H "Authorization: Bearer $PARMANA_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{
                "action": "grant",
                "callerId": "warehouse-agent",
                "capability": "erp:release-goods",
                "limits": {
                  "parameters.amount": { "max": 100000 },
                  "parameters.currency": { "oneOf": ["INR"] }
                },
                "validUntil": "2026-12-30T00:00:00.000Z",
                "reason": "The warehouse agent releases goods for paid invoices up to 100000 INR this quarter."
              }'
        - lang: typescript
          label: TypeScript
          source: |-
            import { ParmanaClient } from "@parmana/sdk";

            const client = new ParmanaClient({
              endpoint: "https://parmana-api-real.vercel.app",
              apiKey: process.env.PARMANA_API_KEY!,
            });

            const change = await client.proposeAuthorityGrantChange({
              action: "grant",
              callerId: "warehouse-agent",
              capability: "erp:release-goods",
              limits: {
                "parameters.amount": { max: 100000 },
                "parameters.currency": { oneOf: ["INR"] },
              },
              validUntil: "2026-12-30T00:00:00.000Z",
              reason:
                "The warehouse agent releases goods for paid invoices up to 100000 INR this quarter.",
            });

            console.log(change.changeId);
        - lang: python
          label: Python
          source: |-
            import os

            from parmana import ParmanaClient

            client = ParmanaClient(
                endpoint="https://parmana-api-real.vercel.app",
                api_key=os.environ["PARMANA_API_KEY"],
            )

            change = client.authority_grants.propose_grant(
                caller_id="warehouse-agent",
                capability="erp:release-goods",
                limits={
                    "parameters.amount": {"max": 100000},
                    "parameters.currency": {"oneOf": ["INR"]},
                },
                valid_until="2026-12-30T00:00:00.000Z",
                reason=(
                    "The warehouse agent releases goods for paid invoices up to 100000 INR "
                    "this quarter."
                ),
            )

            print(change.change_id)
components:
  schemas:
    propose-authority-grant-change-request.schema:
      title: Propose Authority Grant Change Request
      description: >-
        Request body for POST /authority-grants/changes. A grant carries
        validUntil and optionally limits and validFrom; a revoke carries none of
        them.
      type: object
      additionalProperties: true
      required:
        - action
        - callerId
        - capability
        - reason
      properties:
        action:
          type: string
          enum:
            - grant
            - revoke
        callerId:
          type: string
          pattern: ^\S{1,256}$
          description: The callerId of the API key the grant is for. Not your own.
        capability:
          type: string
          pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*:[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
          maxLength: 128
        limits:
          type: object
          description: >-
            Optional, grant only. Limits on the request, by Intent path: target
            or parameters.<name>. min and max (inclusive) apply to a number
            there; oneOf lists the only values allowed there. A request whose
            value is missing, of another type, or outside a limit is
            NOT_AUTHORIZED.
          maxProperties: 32
          propertyNames:
            pattern: ^(?:target|parameters\.[A-Za-z_][A-Za-z0-9_]{0,63})$
          additionalProperties:
            type: object
            additionalProperties: false
            minProperties: 1
            properties:
              min:
                type: number
              max:
                type: number
              oneOf:
                type: array
                minItems: 1
                maxItems: 64
                items:
                  type:
                    - string
                    - number
        validFrom:
          type: string
          format: date-time
          description: Optional, grant only.
        validUntil:
          type: string
          format: date-time
          description: >-
            Required for grant. In the future, after validFrom, and at most 366
            days after it.
        reason:
          type: string
          minLength: 1
          maxLength: 2000
      examples:
        - action: grant
          callerId: warehouse-agent
          capability: erp:release-goods
          limits:
            parameters.amount:
              max: 100000
            parameters.currency:
              oneOf:
                - INR
          validUntil: '2026-12-30T00:00:00.000Z'
          reason: >-
            The warehouse agent releases goods for paid invoices up to 100000
            INR this quarter.
        - action: revoke
          callerId: warehouse-agent
          capability: erp:release-goods
          reason: The warehouse agent's key is being rotated.
    authority-grant-change-response.schema:
      $ref: '#/components/schemas/authority-grant-change.schema'
      title: Authority Grant Change Response
      description: >-
        Response of POST /authority-grants/changes (201) and of approve and
        reject (200). A bare Authority Grant Change, no wrapper.
    error.schema:
      title: Error Response
      description: >-
        Shared error envelope produced by
        packages/api/src/middleware/error-handler.ts and by every route's inline
        validation checks. error is always a plain human-readable string (never
        a nested object). code is present only when the failure was a
        RuntimeError subclass reaching the centralized error handler
        (VerificationFailedError, ReceiptGenerationError, or an uncategorized
        RuntimeError); it is absent from every inline route-level check
        (businessTransactionId format/required checks) and from
        BusinessTransactionValidationError, PolicyValidationError,
        SignalValidationError, PolicyNotFoundError,
        DuplicateBusinessTransactionError, and the generic 500 fallback. POST
        /policies/validate does NOT use this envelope at all. See its own
        response schema. For the triggering condition and recommended caller
        action behind any specific error/code/status combination, see the Error
        catalog at /api-reference/error-catalog.
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: >-
            Stable machine-readable error code. Only present for errors that
            reach the handler as a RuntimeError.
          examples:
            - RUNTIME_ERROR
            - VERIFICATION_FAILED
            - RECEIPT_GENERATION_FAILED
            - POLICY_DENIED
            - CAPABILITY_NOT_ALLOWED
            - RATE_LIMITED
            - AUDIT_UNAVAILABLE
            - SIGNING_UNAVAILABLE
            - CONNECTOR_NOT_REGISTERED
            - EXECUTION_RECORD_INCOMPLETE
            - EXECUTION_INTENT_UNAVAILABLE
            - EXECUTION_INTENT_RESULT_NOT_RECORDED
            - EXECUTION_INTENT_NOT_FOUND
            - EXECUTION_INTENTS_NOT_ENABLED
            - EXECUTION_INTENT_NOT_RESOLVABLE
            - EXECUTION_INTENT_RESOLUTION_INVALID
            - NON_HUMAN_CALLER_DENIED
            - EXECUTION_OUTCOME_UNKNOWN
            - AUTHORIZATION_NO_LONGER_VALID
        executionStatus:
          type: string
          enum:
            - EXECUTION_UNKNOWN
            - NOT_EXECUTED
          description: >-
            RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN:
            the action was released and the call failed, so whether it ran is
            unknown; never reported as failed, and the Execution Intent stays
            ERRORED until a person resolves it. NOT_EXECUTED with
            AUTHORIZATION_NO_LONGER_VALID: the release was refused because a
            business condition or the authority grant it rested on no longer
            held, and nothing was sent.
      examples:
        - error: businessTransactionId must be a valid UUID.
        - error: >-
            Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already
            exists.
        - error: >-
            Execution rejected: Vendor payment rejected because the assessed
            payment risk exceeds the maximum permitted threshold.
          code: RUNTIME_ERROR
    authority-grant-change.schema:
      title: Authority Grant Change
      description: >-
        A proposal to grant a caller authority for a capability, or to revoke
        the active grant, and its resolution (RFC-0023 phase 3). One person
        proposes it; a different person approves or rejects it with a step up
        authorization; neither may be the caller the grant is for.
      type: object
      additionalProperties: false
      required:
        - changeId
        - action
        - callerId
        - capability
        - reason
        - proposedBy
        - proposedAt
        - status
      properties:
        changeId:
          type: string
          description: >-
            Unique id of the change, a UUID. The step up authorization for
            approve or reject names it in payload.pendingPolicyChangeId. An
            approved grant change's id is also the grantId.
        action:
          type: string
          enum:
            - grant
            - revoke
        callerId:
          type: string
        capability:
          type: string
          pattern: ^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*:[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$
        limits:
          type: object
          description: >-
            grant only, optional. Limits on the request, by Intent path: target
            or parameters.<name>. min and max (inclusive) apply to a number
            there; oneOf lists the only values allowed there. A request whose
            value is missing, of another type, or outside a limit is
            NOT_AUTHORIZED.
          maxProperties: 32
          propertyNames:
            pattern: ^(?:target|parameters\.[A-Za-z_][A-Za-z0-9_]{0,63})$
          additionalProperties:
            type: object
            additionalProperties: false
            minProperties: 1
            properties:
              min:
                type: number
              max:
                type: number
              oneOf:
                type: array
                minItems: 1
                maxItems: 64
                items:
                  type:
                    - string
                    - number
        validFrom:
          type: string
          format: date-time
          description: >-
            grant only, optional. Without it the grant starts when it is
            approved.
        validUntil:
          type: string
          format: date-time
          description: >-
            grant only, required. At most 366 days after validFrom (or the
            proposal).
        reason:
          type: string
          maxLength: 2000
        proposedBy:
          type: string
          description: >-
            The proposer's caller id. Always a human credential, never the
            grantee.
        proposedAt:
          type: string
          format: date-time
        status:
          type: string
          enum:
            - PENDING_APPROVAL
            - APPROVED
            - REJECTED
        resolvedBy:
          type: string
          description: Who approved or rejected it. Never the proposer or the grantee.
        resolvedAt:
          type: string
          format: date-time
        rejectionReason:
          type: string
          description: Present when REJECTED.
      examples:
        - changeId: 9f3cf733-a8ed-487c-bb58-a53950388cdf
          action: grant
          callerId: warehouse-agent
          capability: erp:release-goods
          limits:
            parameters.amount:
              max: 100000
            parameters.currency:
              oneOf:
                - INR
          validUntil: '2026-12-30T00:00:00.000Z'
          reason: >-
            The warehouse agent releases goods for paid invoices up to 100000
            INR this quarter.
          proposedBy: grant-maker
          proposedAt: '2026-10-11T03:29:05.220Z'
          status: APPROVED
          resolvedBy: grant-checker
          resolvedAt: '2026-10-11T03:29:05.247Z'
  responses:
    Unauthorized:
      description: >-
        The `Authorization` header is missing, is not a bearer key, or names a
        key the server does not know. Nothing ran. Send a valid key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error.schema'
          examples:
            authRequired:
              summary: Real captured response, missing or invalid Authorization header
              value:
                error: authentication required
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      x-default: 2VfYWCzt_cBAPK-8uufX6ordfY2JuQhFPsohuEumKME
      description: >
        Caller API key issued by scripts/generate-api-key.ts. Sent as
        Authorization: Bearer <key>. Verified against a stored SHA-256 hash in
        constant time by packages/api/src/auth/StaticKeyAuthenticator.ts.
        Required on every route not listed as exempt in this document's
        top-level description. See /api-reference/authentication.

````

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