Permit.io API — User Invites

naftiko: 1.0.0-alpha2
info:
  label: Permit.io API — User Invites
  description: 'Permit.io API — User Invites. 6 operations. Lead operation: List User Invites. Self-contained Naftiko capability
    covering one Permit Io business surface.'
  tags:
  - Permit Io
  - User Invites
  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-user-invites
    baseUri: ''
    description: Permit.io API — User Invites business capability. Self-contained, no shared references.
    resources:
    - name: v2-facts-proj_id-env_id-user_invites
      path: /v2/facts/{proj_id}/{env_id}/user_invites
      operations:
      - name: listuserinvites
        method: GET
        description: List User Invites
        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: role
          in: query
          type: string
          description: optional role filter, will only return invited users with this role.
        - name: tenant
          in: query
          type: string
          description: optional tenant filter, will only return invited users in that tenant.
        - name: search
          in: query
          type: string
          description: optional search, will only return invited users to that email, key or name.
        - name: page
          in: query
          type: integer
          description: Page number of the results to fetch, starting at 1.
        - name: per_page
          in: query
          type: integer
          description: The number of results per page (max 100).
      - name: createuserinvite
        method: POST
        description: Create User Invite
        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: v2-facts-proj_id-env_id-user_invites-user_invite_id
      path: /v2/facts/{proj_id}/{env_id}/user_invites/{user_invite_id}
      operations:
      - name: getuserinvite
        method: GET
        description: Get User Invite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_invite_id
          in: path
          type: string
          description: 'Either the unique id of the user_invite, or the URL-friendly key of the user_invite (i.e: the "slug").'
          required: true
        - 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: deleteuserinvite
        method: DELETE
        description: Delete User Invite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_invite_id
          in: path
          type: string
          description: 'Either the unique id of the user_invite, or the URL-friendly key of the user_invite (i.e: the "slug").'
          required: true
        - 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: updateuserinvite
        method: PATCH
        description: Update User Invite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_invite_id
          in: path
          type: string
          description: 'Either the unique id of the user_invite, or the URL-friendly key of the user_invite (i.e: the "slug").'
          required: true
        - 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: v2-facts-proj_id-env_id-user_invites-user_invite_id-approve
      path: /v2/facts/{proj_id}/{env_id}/user_invites/{user_invite_id}/approve
      operations:
      - name: approveuserinvite
        method: POST
        description: Approve User Invite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user_invite_id
          in: path
          type: string
          description: 'Either the unique id of the user_invite, or the URL-friendly key of the user_invite (i.e: the "slug").'
          required: true
        - 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
    authentication:
      type: bearer
      token: '{{env.PERMIT_IO_API_KEY}}'
  exposes:
  - type: rest
    namespace: permit-io-user-invites-rest
    port: 8080
    description: REST adapter for Permit.io API — User Invites. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v2/facts/{proj-id}/{env-id}/user-invites
      name: v2-facts-proj-id-env-id-user-invites
      description: REST surface for v2-facts-proj_id-env_id-user_invites.
      operations:
      - method: GET
        name: listuserinvites
        description: List User Invites
        call: permit-io-user-invites.listuserinvites
        with:
          proj_id: rest.proj_id
          env_id: rest.env_id
          role: rest.role
          tenant: rest.tenant
          search: rest.search
          page: rest.page
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuserinvite
        description: Create User Invite
        call: permit-io-user-invites.createuserinvite
        with:
          proj_id: rest.proj_id
          env_id: rest.env_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/facts/{proj-id}/{env-id}/user-invites/{user-invite-id}
      name: v2-facts-proj-id-env-id-user-invites-user-invite-id
      description: REST surface for v2-facts-proj_id-env_id-user_invites-user_invite_id.
      operations:
      - method: GET
        name: getuserinvite
        description: Get User Invite
        call: permit-io-user-invites.getuserinvite
        with:
          user_invite_id: rest.user_invite_id
          proj_id: rest.proj_id
          env_id: rest.env_id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuserinvite
        description: Delete User Invite
        call: permit-io-user-invites.deleteuserinvite
        with:
          user_invite_id: rest.user_invite_id
          proj_id: rest.proj_id
          env_id: rest.env_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateuserinvite
        description: Update User Invite
        call: permit-io-user-invites.updateuserinvite
        with:
          user_invite_id: rest.user_invite_id
          proj_id: rest.proj_id
          env_id: rest.env_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/facts/{proj-id}/{env-id}/user-invites/{user-invite-id}/approve
      name: v2-facts-proj-id-env-id-user-invites-user-invite-id-approve
      description: REST surface for v2-facts-proj_id-env_id-user_invites-user_invite_id-approve.
      operations:
      - method: POST
        name: approveuserinvite
        description: Approve User Invite
        call: permit-io-user-invites.approveuserinvite
        with:
          user_invite_id: rest.user_invite_id
          proj_id: rest.proj_id
          env_id: rest.env_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: permit-io-user-invites-mcp
    port: 9090
    transport: http
    description: MCP adapter for Permit.io API — User Invites. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-user-invites
      description: List User Invites
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: permit-io-user-invites.listuserinvites
      with:
        proj_id: tools.proj_id
        env_id: tools.env_id
        role: tools.role
        tenant: tools.tenant
        search: tools.search
        page: tools.page
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-user-invite
      description: Create User Invite
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: permit-io-user-invites.createuserinvite
      with:
        proj_id: tools.proj_id
        env_id: tools.env_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-invite
      description: Get User Invite
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: permit-io-user-invites.getuserinvite
      with:
        user_invite_id: tools.user_invite_id
        proj_id: tools.proj_id
        env_id: tools.env_id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user-invite
      description: Delete User Invite
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: permit-io-user-invites.deleteuserinvite
      with:
        user_invite_id: tools.user_invite_id
        proj_id: tools.proj_id
        env_id: tools.env_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user-invite
      description: Update User Invite
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: permit-io-user-invites.updateuserinvite
      with:
        user_invite_id: tools.user_invite_id
        proj_id: tools.proj_id
        env_id: tools.env_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: approve-user-invite
      description: Approve User Invite
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: permit-io-user-invites.approveuserinvite
      with:
        user_invite_id: tools.user_invite_id
        proj_id: tools.proj_id
        env_id: tools.env_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.