Portkey API — User-invites

naftiko: 1.0.0-alpha2
info:
  label: Portkey API — User-invites
  description: 'Portkey API — User-invites. 5 operations. Lead operation: Invite User. Self-contained Naftiko capability covering
    one Portkey business surface.'
  tags:
  - Portkey
  - User-invites
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTKEY_API_KEY: PORTKEY_API_KEY
capability:
  consumes:
  - type: http
    namespace: portkey-user-invites
    baseUri: https://api.portkey.ai/v1
    description: Portkey API — User-invites business capability. Self-contained, no shared references.
    resources:
    - name: admin-users-invites
      path: /admin/users/invites
      operations:
      - name: invitescreate
        method: POST
        description: Invite User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: get
        method: GET
        description: Get All Invites
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: pageSize
          in: query
          type: integer
        - name: currentPage
          in: query
          type: integer
        - name: role
          in: query
          type: string
        - name: email
          in: query
          type: string
        - name: status
          in: query
          type: string
    - name: admin-users-invites-inviteId
      path: /admin/users/invites/{inviteId}
      operations:
      - name: get
        method: GET
        description: Get Invite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inviteId
          in: path
          type: string
          description: string
          required: true
      - name: delete
        method: DELETE
        description: Delete Invite By ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inviteId
          in: path
          type: string
          required: true
    - name: admin-users-invites-inviteId-resend
      path: /admin/users/invites/{inviteId}/resend
      operations:
      - name: post
        method: POST
        description: Resend Invite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: inviteId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.PORTKEY_API_KEY}}'
  exposes:
  - type: rest
    namespace: portkey-user-invites-rest
    port: 8080
    description: REST adapter for Portkey API — User-invites. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/admin/users/invites
      name: admin-users-invites
      description: REST surface for admin-users-invites.
      operations:
      - method: POST
        name: invitescreate
        description: Invite User
        call: portkey-user-invites.invitescreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: get
        description: Get All Invites
        call: portkey-user-invites.get
        with:
          pageSize: rest.pageSize
          currentPage: rest.currentPage
          role: rest.role
          email: rest.email
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/users/invites/{inviteid}
      name: admin-users-invites-inviteid
      description: REST surface for admin-users-invites-inviteId.
      operations:
      - method: GET
        name: get
        description: Get Invite
        call: portkey-user-invites.get
        with:
          inviteId: rest.inviteId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete Invite By ID
        call: portkey-user-invites.delete
        with:
          inviteId: rest.inviteId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/admin/users/invites/{inviteid}/resend
      name: admin-users-invites-inviteid-resend
      description: REST surface for admin-users-invites-inviteId-resend.
      operations:
      - method: POST
        name: post
        description: Resend Invite
        call: portkey-user-invites.post
        with:
          inviteId: rest.inviteId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portkey-user-invites-mcp
    port: 9090
    transport: http
    description: MCP adapter for Portkey API — User-invites. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: invite-user
      description: Invite User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portkey-user-invites.invitescreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-invites
      description: Get All Invites
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-user-invites.get
      with:
        pageSize: tools.pageSize
        currentPage: tools.currentPage
        role: tools.role
        email: tools.email
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: get-invite
      description: Get Invite
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portkey-user-invites.get
      with:
        inviteId: tools.inviteId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-invite-id
      description: Delete Invite By ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: portkey-user-invites.delete
      with:
        inviteId: tools.inviteId
      outputParameters:
      - type: object
        mapping: $.
    - name: resend-invite
      description: Resend Invite
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portkey-user-invites.post
      with:
        inviteId: tools.inviteId
      outputParameters:
      - type: object
        mapping: $.