APIs.io Engineering Platform Postman API — Roles

naftiko: 1.0.0-alpha2
info:
  label: APIs.io Engineering Platform Postman API — Roles
  description: 'APIs.io Engineering Platform Postman API — Roles. 5 operations. Lead operation: APIs.io Engineering Platform
    Get a collection''s roles. Self-contained Naftiko capability covering one Engineering Platform business surface.'
  tags:
  - Engineering Platform
  - Roles
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ENGINEERING_PLATFORM_API_KEY: ENGINEERING_PLATFORM_API_KEY
capability:
  consumes:
  - type: http
    namespace: postman-roles
    baseUri: https://api.getpostman.com
    description: APIs.io Engineering Platform Postman API — Roles business capability. Self-contained, no shared references.
    resources:
    - name: collections-collectionId-roles
      path: /collections/{collectionId}/roles
      operations:
      - name: getcollectionroles
        method: GET
        description: APIs.io Engineering Platform Get a collection's roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecollectionroles
        method: PATCH
        description: APIs.io Engineering Platform Update a collection's roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: workspaces-roles
      path: /workspaces-roles
      operations:
      - name: getallworkspaceroles
        method: GET
        description: APIs.io Engineering Platform Get all roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: workspaces-workspaceId-roles
      path: /workspaces/{workspaceId}/roles
      operations:
      - name: updateworkspaceroles
        method: PATCH
        description: APIs.io Engineering Platform Update user or user group roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getworkspaceroles
        method: GET
        description: APIs.io Engineering Platform Get a workspace's roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: x-api-key
      value: '{{env.ENGINEERING_PLATFORM_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: postman-roles-rest
    port: 8080
    description: REST adapter for APIs.io Engineering Platform Postman API — Roles. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/collections/{collectionid}/roles
      name: collections-collectionid-roles
      description: REST surface for collections-collectionId-roles.
      operations:
      - method: GET
        name: getcollectionroles
        description: APIs.io Engineering Platform Get a collection's roles
        call: postman-roles.getcollectionroles
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatecollectionroles
        description: APIs.io Engineering Platform Update a collection's roles
        call: postman-roles.updatecollectionroles
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workspaces-roles
      name: workspaces-roles
      description: REST surface for workspaces-roles.
      operations:
      - method: GET
        name: getallworkspaceroles
        description: APIs.io Engineering Platform Get all roles
        call: postman-roles.getallworkspaceroles
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workspaces/{workspaceid}/roles
      name: workspaces-workspaceid-roles
      description: REST surface for workspaces-workspaceId-roles.
      operations:
      - method: PATCH
        name: updateworkspaceroles
        description: APIs.io Engineering Platform Update user or user group roles
        call: postman-roles.updateworkspaceroles
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getworkspaceroles
        description: APIs.io Engineering Platform Get a workspace's roles
        call: postman-roles.getworkspaceroles
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: postman-roles-mcp
    port: 9090
    transport: http
    description: MCP adapter for APIs.io Engineering Platform Postman API — Roles. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: apis-io-engineering-platform-get-collection-s
      description: APIs.io Engineering Platform Get a collection's roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: postman-roles.getcollectionroles
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-update-collection-s
      description: APIs.io Engineering Platform Update a collection's roles
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: postman-roles.updatecollectionroles
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-get-all
      description: APIs.io Engineering Platform Get all roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: postman-roles.getallworkspaceroles
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-update-user
      description: APIs.io Engineering Platform Update user or user group roles
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: postman-roles.updateworkspaceroles
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: apis-io-engineering-platform-get-workspace-s
      description: APIs.io Engineering Platform Get a workspace's roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: postman-roles.getworkspaceroles
      outputParameters:
      - type: object
        mapping: $.