Oracle GoldenGate Veridata REST API — Users

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate Veridata REST API — Users
  description: 'Oracle GoldenGate Veridata REST API — Users. 10 operations. Lead operation: Oracle Goldengate Retrieve All
    User Groups. Self-contained Naftiko capability covering one Oracle Goldengate business surface.'
  tags:
  - Oracle Goldengate
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_GOLDENGATE_API_KEY: ORACLE_GOLDENGATE_API_KEY
capability:
  consumes:
  - type: http
    namespace: veridata-rest-users
    baseUri: https://{veridata-host}:{port}/veridata/v1
    description: Oracle GoldenGate Veridata REST API — Users business capability. Self-contained, no shared references.
    resources:
    - name: services-admin-usergroups
      path: /services/admin/usergroups
      operations:
      - name: listusergroups
        method: GET
        description: Oracle Goldengate Retrieve All User Groups
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createusergroup
        method: POST
        description: Oracle Goldengate Create a User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: services-admin-usergroups-Id
      path: /services/admin/usergroups/{Id}
      operations:
      - name: getusergroup
        method: GET
        description: Oracle Goldengate Retrieve a User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: replaceusergroup
        method: PUT
        description: Oracle Goldengate Replace a User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteusergroup
        method: DELETE
        description: Oracle Goldengate Delete a User Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-admin-users
      path: /services/admin/users
      operations:
      - name: listusers
        method: GET
        description: Oracle Goldengate Retrieve All Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Oracle Goldengate Create a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: services-admin-users-Id
      path: /services/admin/users/{Id}
      operations:
      - name: getuser
        method: GET
        description: Oracle Goldengate Retrieve a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: replaceuser
        method: PUT
        description: Oracle Goldengate Replace a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteuser
        method: DELETE
        description: Oracle Goldengate Delete a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.ORACLE_GOLDENGATE_USER}}'
      password: '{{env.ORACLE_GOLDENGATE_PASS}}'
  exposes:
  - type: rest
    namespace: veridata-rest-users-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate Veridata REST API — Users. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/services/admin/usergroups
      name: services-admin-usergroups
      description: REST surface for services-admin-usergroups.
      operations:
      - method: GET
        name: listusergroups
        description: Oracle Goldengate Retrieve All User Groups
        call: veridata-rest-users.listusergroups
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createusergroup
        description: Oracle Goldengate Create a User Group
        call: veridata-rest-users.createusergroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/admin/usergroups/{id}
      name: services-admin-usergroups-id
      description: REST surface for services-admin-usergroups-Id.
      operations:
      - method: GET
        name: getusergroup
        description: Oracle Goldengate Retrieve a User Group
        call: veridata-rest-users.getusergroup
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: replaceusergroup
        description: Oracle Goldengate Replace a User Group
        call: veridata-rest-users.replaceusergroup
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteusergroup
        description: Oracle Goldengate Delete a User Group
        call: veridata-rest-users.deleteusergroup
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/admin/users
      name: services-admin-users
      description: REST surface for services-admin-users.
      operations:
      - method: GET
        name: listusers
        description: Oracle Goldengate Retrieve All Users
        call: veridata-rest-users.listusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Oracle Goldengate Create a User
        call: veridata-rest-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/admin/users/{id}
      name: services-admin-users-id
      description: REST surface for services-admin-users-Id.
      operations:
      - method: GET
        name: getuser
        description: Oracle Goldengate Retrieve a User
        call: veridata-rest-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: replaceuser
        description: Oracle Goldengate Replace a User
        call: veridata-rest-users.replaceuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Oracle Goldengate Delete a User
        call: veridata-rest-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: veridata-rest-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate Veridata REST API — Users. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: oracle-goldengate-retrieve-all-user
      description: Oracle Goldengate Retrieve All User Groups
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-users.listusergroups
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-create-user-group
      description: Oracle Goldengate Create a User Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: veridata-rest-users.createusergroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-user-group
      description: Oracle Goldengate Retrieve a User Group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-users.getusergroup
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-replace-user-group
      description: Oracle Goldengate Replace a User Group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: veridata-rest-users.replaceusergroup
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-delete-user-group
      description: Oracle Goldengate Delete a User Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: veridata-rest-users.deleteusergroup
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-all-users
      description: Oracle Goldengate Retrieve All Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-users.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-create-user
      description: Oracle Goldengate Create a User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: veridata-rest-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-user
      description: Oracle Goldengate Retrieve a User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-replace-user
      description: Oracle Goldengate Replace a User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: veridata-rest-users.replaceuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-delete-user
      description: Oracle Goldengate Delete a User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: veridata-rest-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.