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

# Create a PermissionAssignment

> Create one immutable PermissionAssignment binding a subject (principal, group, agent definition, agent installation, surface scope, or session) to one enumerated resource and one permission. Each resource kind admits only its own permissions, so an impossible pairing is rejected rather than stored. Bounds require canonical UTC timestamps with exactly three fractional digits. PermissionAssignments are never patched: delete and recreate to change one. Accepts an Idempotency-Key.

Checkfu support posture: alpha; hosted. Required evidence journey: governance-registry. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.



## OpenAPI

````yaml /openapi.json post /v1/permission-assignments
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-27'
  description: >-
    Authentication is declared per operation: API-key, runtime, or connector
    bearer; Automation signature; or credential-free pairing redemption. Every
    general Checkfu REST request requires the dated `Checkfu-Version` header
    (one of: 2026-08-27); the three MCP JSON-RPC transports use
    `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth
    callback carries neither Checkfu header. API keys resolve one Workspace
    without a request selector; authenticated responses identify it with
    `Checkfu-Workspace-Id`.
servers:
  - url: https://api.checkfu.com
security:
  - bearerAuth: []
tags:
  - name: organizations
  - name: sourceRepositories
  - name: tenants
  - name: workspaces
  - name: principals
  - name: principalGroups
  - name: principalAccessCredentials
  - name: apiKeys
  - name: agents
  - name: harnesses
  - name: harnessRuntime
  - name: computerProfiles
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: dreams
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: blueprintInstallations
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentSources
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: projects
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - name: usage
  - name: models
  - name: outcomes
  - name: budgets
  - name: billing
  - name: sessions
  - name: audit
  - name: sessionExports
  - name: runs
  - name: runnerPools
  - name: transcripts
  - name: sessionWatches
  - name: sessionHandoffs
  - name: sessionCapsules
  - name: sessionTrajectories
  - name: webhookEndpoints
  - name: integrationGateway
  - name: agentDeployments
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/permission-assignments:
    post:
      tags:
        - permissionAssignments
      summary: Create a PermissionAssignment
      description: >-
        Create one immutable PermissionAssignment binding a subject (principal,
        group, agent definition, agent installation, surface scope, or session)
        to one enumerated resource and one permission. Each resource kind admits
        only its own permissions, so an impossible pairing is rejected rather
        than stored. Bounds require canonical UTC timestamps with exactly three
        fractional digits. PermissionAssignments are never patched: delete and
        recreate to change one. Accepts an Idempotency-Key.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        governance-registry. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: permissionAssignments.createPermissionAssignment
      parameters:
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-27'
          required: true
        - name: idempotency-key
          in: header
          schema:
            type: string
            allOf:
              - maxLength: 255
          required: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subject:
                  $ref: '#/components/schemas/Union_94'
                resource:
                  $ref: '#/components/schemas/Objects_45'
                permission:
                  $ref: '#/components/schemas/Union_96'
                expires_at:
                  $ref: '#/components/schemas/AuditTimestamp'
                valid_from:
                  $ref: '#/components/schemas/AuditTimestamp'
                rationale:
                  type: string
                  allOf:
                    - minLength: 1
                    - maxLength: 512
              required:
                - subject
                - resource
                - permission
              additionalProperties: false
        required: true
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/components/schemas/PermissionAssignmentId'
                  subject:
                    $ref: '#/components/schemas/Union_94'
                  resource:
                    $ref: '#/components/schemas/Objects_45'
                  permission:
                    $ref: '#/components/schemas/Union_96'
                  resource_version:
                    type: integer
                    allOf:
                      - exclusiveMinimum: 0
                  created_at:
                    type: string
                  updated_at:
                    type: string
                  expires_at:
                    $ref: '#/components/schemas/AuditTimestamp'
                  valid_from:
                    $ref: '#/components/schemas/AuditTimestamp'
                  rationale:
                    type: string
                    allOf:
                      - minLength: 1
                      - maxLength: 512
                required:
                  - id
                  - subject
                  - resource
                  - permission
                  - resource_version
                  - created_at
                  - updated_at
                additionalProperties: false
          headers:
            checkfu-workspace-id:
              description: The Workspace resolved from the authenticated bearer credential.
              required: true
              schema:
                $ref: '#/components/schemas/WorkspaceId'
        '400':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationMalformedError'
        '401':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - auth.invalid_key
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#auth-invalid-key
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '403':
          description: >-
            The organization, tenant, or workspace backing this key is
            administratively disabled. | Deployment governance or retention
            policy denied the request.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - auth.disabled_tenancy
                          message:
                            type: string
                          more:
                            type: string
                            enum:
                              - >-
                                https://docs.checkfu.com/reference/errors#auth-disabled-tenancy
                            description: >-
                              Stable public documentation and remedy for this
                              error type.
                        required:
                          - type
                          - message
                          - more
                        additionalProperties: false
                    additionalProperties: false
                  - $ref: '#/components/schemas/PolicyDeniedError'
        '404':
          description: >-
            The requested resource does not exist in the resolved deployment
            boundary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationNotFoundError'
        '409':
          description: >-
            The request conflicts with the resource's current state. | An
            idempotent mutation conflicts with a completed or in-progress
            request for the same key.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ValidationConflictError'
                  - $ref: '#/components/schemas/IdempotencyConflictError'
        '429':
          description: Typed Checkfu wire error
          headers:
            retry-after:
              description: >-
                Delay in seconds for rate limits or deployment quotas with a
                known release or UTC reset boundary
              required: false
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - budget.exceeded
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#budget-exceeded
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '500':
          description: >-
            An unexpected internal failure occurred; the message contains an
            opaque incident reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    Union_94:
      anyOf:
        - type: object
          properties:
            kind:
              type: string
              enum:
                - principal
            principal:
              $ref: '#/components/schemas/PrincipalId'
          required:
            - kind
            - principal
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - group
            group:
              $ref: '#/components/schemas/PrincipalGroupId'
          required:
            - kind
            - group
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - agent_definition
            agent:
              $ref: '#/components/schemas/AgentId'
          required:
            - kind
            - agent
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - agent_installation
            installation:
              $ref: '#/components/schemas/AgentInstallationId'
          required:
            - kind
            - installation
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - surface_scope
            surface:
              $ref: '#/components/schemas/SurfaceScopeId'
          required:
            - kind
            - surface
          additionalProperties: false
        - type: object
          properties:
            kind:
              type: string
              enum:
                - session
            session:
              $ref: '#/components/schemas/SessionId'
          required:
            - kind
            - session
          additionalProperties: false
    Objects_45:
      type: object
      properties:
        kind:
          $ref: '#/components/schemas/Union_95'
        id:
          type: string
          allOf:
            - minLength: 1
      required:
        - kind
        - id
      additionalProperties: false
    Union_96:
      type: string
      enum:
        - read
        - write
        - use
        - invoke
        - steer
        - observe
        - approve
        - edit
        - view
        - act_as
        - use_agent
        - use_connection
        - use_tool
        - use_memory
        - use_model
        - use_harness
        - use_environment
        - publish_artifact
        - create_routine
        - manage_routine
    AuditTimestamp:
      type: string
      allOf:
        - maxLength: 24
        - pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,3})?Z$
          description: >-
            A retained audit timestamp using the historical zero-to-three
            fractional-digit encoding.
    PermissionAssignmentId:
      type: string
      allOf:
        - pattern: ^perm_[0-9a-f]{32}$
    WorkspaceId:
      type: string
      allOf:
        - pattern: ^wrkspc_[0-9a-f]{32}$
    ValidationMalformedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.malformed
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-malformed
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The request could not be decoded or violated a declared input
        constraint.
    PolicyDeniedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - policy.denied
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#policy-denied
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: Deployment governance or retention policy denied the request.
    ValidationNotFoundError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.not_found
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-not-found
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The requested resource does not exist in the resolved deployment
        boundary.
    ValidationConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.conflict
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-conflict
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: The request conflicts with the resource's current state.
    IdempotencyConflictError:
      anyOf:
        - $ref: '#/components/schemas/ValidationIdempotencyConflictError'
        - $ref: '#/components/schemas/ValidationIdempotencyInProgressError'
      description: >-
        An idempotent mutation conflicts with a completed or in-progress request
        for the same key.
    RuntimeInternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - runtime.internal
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#runtime-internal
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An unexpected internal failure occurred; the message contains an opaque
        incident reference.
    PrincipalId:
      type: string
      allOf:
        - pattern: ^prin_[0-9a-f]{32}$
    PrincipalGroupId:
      type: string
      allOf:
        - pattern: ^pgrp_[0-9a-f]{32}$
    AgentId:
      type: string
      allOf:
        - pattern: ^agent_[0-9a-f]{32}$
    AgentInstallationId:
      type: string
      allOf:
        - pattern: ^aini_[0-9a-f]{32}$
    SurfaceScopeId:
      type: string
      allOf:
        - pattern: ^surf_[0-9a-f]{32}$
    SessionId:
      type: string
      allOf:
        - pattern: ^sess_[0-9a-f]{32}$
    Union_95:
      type: string
      enum:
        - agent-definition
        - connection
        - tool-source
        - skill
        - memory-store
        - model-binding
        - harness
        - sandbox-profile
        - surface
    ValidationIdempotencyConflictError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.idempotency_conflict
            message:
              type: string
            more:
              type: string
              enum:
                - >-
                  https://docs.checkfu.com/reference/errors#validation-idempotency-conflict
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: The Idempotency-Key is already bound to a different request.
    ValidationIdempotencyInProgressError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.idempotency_in_progress
            message:
              type: string
            more:
              type: string
              enum:
                - >-
                  https://docs.checkfu.com/reference/errors#validation-idempotency-in-progress
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An identical idempotent request is still in progress and may be retried
        later.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````