Red Hat Build of Keycloak Admin REST API — Clients

naftiko: 1.0.0-alpha2
info:
  label: Red Hat Build of Keycloak Admin REST API — Clients
  description: 'Red Hat Build of Keycloak Admin REST API — Clients. 2 operations. Lead operation: Red Hat List Clients. Self-contained
    Naftiko capability covering one Red Hat business surface.'
  tags:
  - Red Hat
  - Clients
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RED_HAT_API_KEY: RED_HAT_API_KEY
capability:
  consumes:
  - type: http
    namespace: keycloak-admin-clients
    baseUri: https://keycloak.example.com
    description: Red Hat Build of Keycloak Admin REST API — Clients business capability. Self-contained, no shared references.
    resources:
    - name: admin-realms-realm-clients
      path: /admin/realms/{realm}/clients
      operations:
      - name: listclients
        method: GET
        description: Red Hat List Clients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: clientId
          in: query
          type: string
          description: Filter by the client identifier.
        - name: first
          in: query
          type: integer
          description: Pagination offset.
        - name: max
          in: query
          type: integer
          description: Maximum number of results.
      - name: createclient
        method: POST
        description: Red Hat Create a Client
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.RED_HAT_API_KEY}}'
  exposes:
  - type: rest
    namespace: keycloak-admin-clients-rest
    port: 8080
    description: REST adapter for Red Hat Build of Keycloak Admin REST API — Clients. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/admin/realms/{realm}/clients
      name: admin-realms-realm-clients
      description: REST surface for admin-realms-realm-clients.
      operations:
      - method: GET
        name: listclients
        description: Red Hat List Clients
        call: keycloak-admin-clients.listclients
        with:
          clientId: rest.clientId
          first: rest.first
          max: rest.max
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createclient
        description: Red Hat Create a Client
        call: keycloak-admin-clients.createclient
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: keycloak-admin-clients-mcp
    port: 9090
    transport: http
    description: MCP adapter for Red Hat Build of Keycloak Admin REST API — Clients. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: red-hat-list-clients
      description: Red Hat List Clients
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: keycloak-admin-clients.listclients
      with:
        clientId: tools.clientId
        first: tools.first
        max: tools.max
      outputParameters:
      - type: object
        mapping: $.
    - name: red-hat-create-client
      description: Red Hat Create a Client
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: keycloak-admin-clients.createclient
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.