Permit.io API — Scope Configurations

naftiko: 1.0.0-alpha2
info:
  label: Permit.io API — Scope Configurations
  description: 'Permit.io API — Scope Configurations. 3 operations. Lead operation: Get Scope Config. Self-contained Naftiko
    capability covering one Permit Io business surface.'
  tags:
  - Permit Io
  - Scope Configurations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PERMIT_IO_API_KEY: PERMIT_IO_API_KEY
capability:
  consumes:
  - type: http
    namespace: permit-io-scope-configurations
    baseUri: ''
    description: Permit.io API — Scope Configurations business capability. Self-contained, no shared references.
    resources:
    - name: v2-projects-proj_id-env_id-opal_scope
      path: /v2/projects/{proj_id}/{env_id}/opal_scope
      operations:
      - name: getscopeconfig
        method: GET
        description: Get Scope Config
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: proj_id
          in: path
          type: string
          description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
          required: true
        - name: env_id
          in: path
          type: string
          description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
          required: true
      - name: setscopeconfig
        method: PUT
        description: Set Scope Config
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: proj_id
          in: path
          type: string
          description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
          required: true
        - name: env_id
          in: path
          type: string
          description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: resetscopeconfig
        method: DELETE
        description: Reset Scope Config
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: proj_id
          in: path
          type: string
          description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
          required: true
        - name: env_id
          in: path
          type: string
          description: 'Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").'
          required: true
    authentication:
      type: bearer
      token: '{{env.PERMIT_IO_API_KEY}}'
  exposes:
  - type: rest
    namespace: permit-io-scope-configurations-rest
    port: 8080
    description: REST adapter for Permit.io API — Scope Configurations. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/projects/{proj-id}/{env-id}/opal-scope
      name: v2-projects-proj-id-env-id-opal-scope
      description: REST surface for v2-projects-proj_id-env_id-opal_scope.
      operations:
      - method: GET
        name: getscopeconfig
        description: Get Scope Config
        call: permit-io-scope-configurations.getscopeconfig
        with:
          proj_id: rest.proj_id
          env_id: rest.env_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: setscopeconfig
        description: Set Scope Config
        call: permit-io-scope-configurations.setscopeconfig
        with:
          proj_id: rest.proj_id
          env_id: rest.env_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: resetscopeconfig
        description: Reset Scope Config
        call: permit-io-scope-configurations.resetscopeconfig
        with:
          proj_id: rest.proj_id
          env_id: rest.env_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: permit-io-scope-configurations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Permit.io API — Scope Configurations. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-scope-config
      description: Get Scope Config
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: permit-io-scope-configurations.getscopeconfig
      with:
        proj_id: tools.proj_id
        env_id: tools.env_id
      outputParameters:
      - type: object
        mapping: $.
    - name: set-scope-config
      description: Set Scope Config
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: permit-io-scope-configurations.setscopeconfig
      with:
        proj_id: tools.proj_id
        env_id: tools.env_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: reset-scope-config
      description: Reset Scope Config
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: permit-io-scope-configurations.resetscopeconfig
      with:
        proj_id: tools.proj_id
        env_id: tools.env_id
      outputParameters:
      - type: object
        mapping: $.