Oracle GoldenGate REST API — Users

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate REST API — Users
  description: 'Oracle GoldenGate REST API — Users. 9 operations. Lead operation: Oracle Goldengate List User Roles. 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: rest-users
    baseUri: https://{goldengate-host}:{port}
    description: Oracle GoldenGate REST API — Users business capability. Self-contained, no shared references.
    resources:
    - name: services-v2-authorizations
      path: /services/v2/authorizations
      operations:
      - name: listuserroles
        method: GET
        description: Oracle Goldengate List User Roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-authorizations-role
      path: /services/v2/authorizations/{role}
      operations:
      - name: listusers
        method: GET
        description: Oracle Goldengate List Users for a Role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: bulkcreateusers
        method: POST
        description: Oracle Goldengate Bulk Create Users for a Role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: services-v2-authorizations-role-user
      path: /services/v2/authorizations/{role}/{user}
      operations:
      - name: getuser
        method: GET
        description: Oracle Goldengate Retrieve a User
        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: updateuser
        method: PATCH
        description: Oracle Goldengate Update 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: $.
    - name: services-v2-currentuser
      path: /services/v2/currentuser
      operations:
      - name: getcurrentuser
        method: GET
        description: Oracle Goldengate Retrieve Current User Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: resetcurrentuserinfo
        method: DELETE
        description: Oracle Goldengate Reset Current User Information
        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: rest-users-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate REST API — Users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/services/v2/authorizations
      name: services-v2-authorizations
      description: REST surface for services-v2-authorizations.
      operations:
      - method: GET
        name: listuserroles
        description: Oracle Goldengate List User Roles
        call: rest-users.listuserroles
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/authorizations/{role}
      name: services-v2-authorizations-role
      description: REST surface for services-v2-authorizations-role.
      operations:
      - method: GET
        name: listusers
        description: Oracle Goldengate List Users for a Role
        call: rest-users.listusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: bulkcreateusers
        description: Oracle Goldengate Bulk Create Users for a Role
        call: rest-users.bulkcreateusers
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/authorizations/{role}/{user}
      name: services-v2-authorizations-role-user
      description: REST surface for services-v2-authorizations-role-user.
      operations:
      - method: GET
        name: getuser
        description: Oracle Goldengate Retrieve a User
        call: rest-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Oracle Goldengate Create a User
        call: rest-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateuser
        description: Oracle Goldengate Update a User
        call: rest-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Oracle Goldengate Delete a User
        call: rest-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/currentuser
      name: services-v2-currentuser
      description: REST surface for services-v2-currentuser.
      operations:
      - method: GET
        name: getcurrentuser
        description: Oracle Goldengate Retrieve Current User Information
        call: rest-users.getcurrentuser
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: resetcurrentuserinfo
        description: Oracle Goldengate Reset Current User Information
        call: rest-users.resetcurrentuserinfo
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate REST API — Users. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: oracle-goldengate-list-user-roles
      description: Oracle Goldengate List User Roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.listuserroles
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-list-users-role
      description: Oracle Goldengate List Users for a Role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-bulk-create-users
      description: Oracle Goldengate Bulk Create Users for a Role
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-users.bulkcreateusers
      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: rest-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-create-user
      description: Oracle Goldengate Create a User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-update-user
      description: Oracle Goldengate Update a User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-users.updateuser
      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: rest-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-current-user
      description: Oracle Goldengate Retrieve Current User Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.getcurrentuser
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-reset-current-user
      description: Oracle Goldengate Reset Current User Information
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-users.resetcurrentuserinfo
      outputParameters:
      - type: object
        mapping: $.