API Reference — RoleService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — RoleService
  description: 'API Reference — RoleService. 7 operations. Lead operation: RoleService. Self-contained Naftiko capability
    covering one Stackrox business surface.'
  tags:
  - Stackrox
  - RoleService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-roleservice
    baseUri: https://{central-host}
    description: API Reference — RoleService business capability. Self-contained, no shared references.
    resources:
    - name: v1-mypermissions
      path: /v1/mypermissions
      operations:
      - name: getmypermissions
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-resources
      path: /v1/resources
      operations:
      - name: getresources
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-roles
      path: /v1/roles
      operations:
      - name: getroles
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-roles-id
      path: /v1/roles/{id}
      operations:
      - name: getrole
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deleterole
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: v1-roles-name
      path: /v1/roles/{name}
      operations:
      - name: createrole
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: updaterole
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-roleservice-rest
    port: 8080
    description: REST adapter for API Reference — RoleService. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/mypermissions
      name: v1-mypermissions
      description: REST surface for v1-mypermissions.
      operations:
      - method: GET
        name: getmypermissions
        description: getmypermissions
        call: stackrox-roleservice.getmypermissions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/resources
      name: v1-resources
      description: REST surface for v1-resources.
      operations:
      - method: GET
        name: getresources
        description: getresources
        call: stackrox-roleservice.getresources
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/roles
      name: v1-roles
      description: REST surface for v1-roles.
      operations:
      - method: GET
        name: getroles
        description: getroles
        call: stackrox-roleservice.getroles
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/roles/{id}
      name: v1-roles-id
      description: REST surface for v1-roles-id.
      operations:
      - method: GET
        name: getrole
        description: getrole
        call: stackrox-roleservice.getrole
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterole
        description: deleterole
        call: stackrox-roleservice.deleterole
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/roles/{name}
      name: v1-roles-name
      description: REST surface for v1-roles-name.
      operations:
      - method: POST
        name: createrole
        description: createrole
        call: stackrox-roleservice.createrole
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterole
        description: updaterole
        call: stackrox-roleservice.updaterole
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-roleservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — RoleService. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: getmypermissions
      description: getmypermissions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-roleservice.getmypermissions
      outputParameters:
      - type: object
        mapping: $.
    - name: getresources
      description: getresources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-roleservice.getresources
      outputParameters:
      - type: object
        mapping: $.
    - name: getroles
      description: getroles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-roleservice.getroles
      outputParameters:
      - type: object
        mapping: $.
    - name: getrole
      description: getrole
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-roleservice.getrole
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: deleterole
      description: deleterole
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-roleservice.deleterole
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: createrole
      description: createrole
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-roleservice.createrole
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: updaterole
      description: updaterole
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-roleservice.updaterole
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.