IAM API — API Keys

naftiko: 1.0.0-alpha2
info:
  label: IAM API — API Keys
  description: 'IAM API — API Keys. 5 operations. Lead operation: List API keys. Self-contained Naftiko capability covering
    one Scaleway business surface.'
  tags:
  - Scaleway
  - API Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SCALEWAY_API_KEY: SCALEWAY_API_KEY
capability:
  consumes:
  - type: http
    namespace: iam-api-keys
    baseUri: https://api.scaleway.com
    description: IAM API — API Keys business capability. Self-contained, no shared references.
    resources:
    - name: iam-v1alpha1-api-keys
      path: /iam/v1alpha1/api-keys
      operations:
      - name: listapikeys
        method: GET
        description: List API keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_by
          in: query
          type: string
          description: Criteria for sorting results.
        - name: page
          in: query
          type: integer
          description: Page number. Value must be greater or equal to 1.
        - name: page_size
          in: query
          type: integer
          description: Number of results per page. Value must be between 1 and 100.
        - name: organization_id
          in: query
          type: string
          description: ID of Organization.
        - name: editable
          in: query
          type: boolean
          description: Defines whether to filter out editable API keys or not.
        - name: expired
          in: query
          type: boolean
          description: Defines whether to filter out expired API keys or not.
        - name: access_key
          in: query
          type: string
          description: Filter by access key (deprecated in favor of `access_keys`).
        - name: description
          in: query
          type: string
          description: Filter by description.
        - name: bearer_id
          in: query
          type: string
          description: Filter by bearer ID.
        - name: bearer_type
          in: query
          type: string
          description: Filter by type of bearer.
        - name: access_keys
          in: query
          type: array
          description: Filter by a list of access keys.
      - name: createapikey
        method: POST
        description: Create an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: iam-v1alpha1-api-keys-access_key
      path: /iam/v1alpha1/api-keys/{access_key}
      operations:
      - name: getapikey
        method: GET
        description: Get an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: access_key
          in: path
          type: string
          description: Access key to search for.
          required: true
      - name: updateapikey
        method: PATCH
        description: Update an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: access_key
          in: path
          type: string
          description: Access key to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapikey
        method: DELETE
        description: Delete an API key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: access_key
          in: path
          type: string
          description: Access key to delete.
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.SCALEWAY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: iam-api-keys-rest
    port: 8080
    description: REST adapter for IAM API — API Keys. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/iam/v1alpha1/api-keys
      name: iam-v1alpha1-api-keys
      description: REST surface for iam-v1alpha1-api-keys.
      operations:
      - method: GET
        name: listapikeys
        description: List API keys
        call: iam-api-keys.listapikeys
        with:
          order_by: rest.order_by
          page: rest.page
          page_size: rest.page_size
          organization_id: rest.organization_id
          editable: rest.editable
          expired: rest.expired
          access_key: rest.access_key
          description: rest.description
          bearer_id: rest.bearer_id
          bearer_type: rest.bearer_type
          access_keys: rest.access_keys
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapikey
        description: Create an API key
        call: iam-api-keys.createapikey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/iam/v1alpha1/api-keys/{access-key}
      name: iam-v1alpha1-api-keys-access-key
      description: REST surface for iam-v1alpha1-api-keys-access_key.
      operations:
      - method: GET
        name: getapikey
        description: Get an API key
        call: iam-api-keys.getapikey
        with:
          access_key: rest.access_key
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateapikey
        description: Update an API key
        call: iam-api-keys.updateapikey
        with:
          access_key: rest.access_key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapikey
        description: Delete an API key
        call: iam-api-keys.deleteapikey
        with:
          access_key: rest.access_key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: iam-api-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for IAM 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: iam-api-keys.listapikeys
      with:
        order_by: tools.order_by
        page: tools.page
        page_size: tools.page_size
        organization_id: tools.organization_id
        editable: tools.editable
        expired: tools.expired
        access_key: tools.access_key
        description: tools.description
        bearer_id: tools.bearer_id
        bearer_type: tools.bearer_type
        access_keys: tools.access_keys
      outputParameters:
      - type: object
        mapping: $.
    - name: create-api-key
      description: Create an API key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: iam-api-keys.createapikey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-api-key
      description: Get an API key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: iam-api-keys.getapikey
      with:
        access_key: tools.access_key
      outputParameters:
      - type: object
        mapping: $.
    - name: update-api-key
      description: Update an API key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: iam-api-keys.updateapikey
      with:
        access_key: tools.access_key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-key
      description: Delete an API key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: iam-api-keys.deleteapikey
      with:
        access_key: tools.access_key
      outputParameters:
      - type: object
        mapping: $.