StepZen Admin API — API Keys

naftiko: 1.0.0-alpha2
info:
  label: StepZen Admin API — API Keys
  description: 'StepZen Admin API — API Keys. 3 operations. Lead operation: List API Keys. Self-contained Naftiko capability
    covering one Stepzen business surface.'
  tags:
  - Stepzen
  - API Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STEPZEN_API_KEY: STEPZEN_API_KEY
capability:
  consumes:
  - type: http
    namespace: admin-api-keys
    baseUri: https://dashboard.ibm.stepzen.com/api/v1
    description: StepZen Admin API — API Keys business capability. Self-contained, no shared references.
    resources:
    - name: api-keys
      path: /api-keys
      operations:
      - name: listapikeys
        method: GET
        description: List API Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createapikey
        method: POST
        description: Create API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-keys-keyId
      path: /api-keys/{keyId}
      operations:
      - name: deleteapikey
        method: DELETE
        description: Delete API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STEPZEN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: admin-api-keys-rest
    port: 8080
    description: REST adapter for StepZen Admin API — API Keys. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api-keys
      name: api-keys
      description: REST surface for api-keys.
      operations:
      - method: GET
        name: listapikeys
        description: List API Keys
        call: admin-api-keys.listapikeys
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapikey
        description: Create API Key
        call: admin-api-keys.createapikey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api-keys/{keyid}
      name: api-keys-keyid
      description: REST surface for api-keys-keyId.
      operations:
      - method: DELETE
        name: deleteapikey
        description: Delete API Key
        call: admin-api-keys.deleteapikey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: admin-api-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for StepZen Admin API — API Keys. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-api-keys
      description: List API Keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: admin-api-keys.listapikeys
      outputParameters:
      - type: object
        mapping: $.
    - name: create-api-key
      description: Create API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: admin-api-keys.createapikey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-key
      description: Delete API Key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: admin-api-keys.deleteapikey
      outputParameters:
      - type: object
        mapping: $.