Oracle GoldenGate

Oracle GoldenGate Users API

User management and authorization

GitHub OpenAPI

Operations 23

GET /services/v2/authorizations Oracle Goldengate List User Roles #
GET /services/v2/authorizations/{role} Oracle Goldengate List Users for a Role #
POST /services/v2/authorizations/{role} Oracle Goldengate Bulk Create Users for a Role #
GET /services/v2/authorizations/{role}/{user} Oracle Goldengate Retrieve a User #
POST /services/v2/authorizations/{role}/{user} Oracle Goldengate Create a User #
PATCH /services/v2/authorizations/{role}/{user} Oracle Goldengate Update a User #
DELETE /services/v2/authorizations/{role}/{user} Oracle Goldengate Delete a User #
GET /services/v2/currentuser Oracle Goldengate Retrieve Current User Information #
DELETE /services/v2/currentuser Oracle Goldengate Reset Current User Information #
GET /services/v1/authorizations/{role} Oracle Goldengate List Users for a Role #
GET /services/v1/authorizations/{role}/{user} Oracle Goldengate Retrieve a User #
POST /services/v1/authorizations/{role}/{user} Oracle Goldengate Create a User #
PATCH /services/v1/authorizations/{role}/{user} Oracle Goldengate Update a User #
GET /services/admin/users Oracle Goldengate Retrieve All Users #
POST /services/admin/users Oracle Goldengate Create a User #
GET /services/admin/users/{Id} Oracle Goldengate Retrieve a User #
PUT /services/admin/users/{Id} Oracle Goldengate Replace a User #
DELETE /services/admin/users/{Id} Oracle Goldengate Delete a User #
GET /services/admin/usergroups Oracle Goldengate Retrieve All User Groups #
POST /services/admin/usergroups Oracle Goldengate Create a User Group #
GET /services/admin/usergroups/{Id} Oracle Goldengate Retrieve a User Group #
PUT /services/admin/usergroups/{Id} Oracle Goldengate Replace a User Group #
DELETE /services/admin/usergroups/{Id} Oracle Goldengate Delete a User Group #

Documentation

📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/core/21.3/oggra/index.html
📖
Authentication
https://docs.oracle.com/en/middleware/goldengate/core/21.3/oggra/authentication.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/core/26/oggra/index.html
📖
Authentication
https://docs.oracle.com/en/database/goldengate/core/26/oggra/authenticate.html
📖
GettingStarted
https://docs.oracle.com/en/database/goldengate/core/26/
📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/index.html
📖
GettingStarted
https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/getting-started.html
📖
Documentation
https://docs.oracle.com/en/middleware/goldengate/veridata/12.2.1.4/gvdug/index.html
📖
APIReference
https://docs.oracle.com/en/middleware/goldengate/veridata/12.2.1.4/gvdra/index.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/veridata/26/
📖
Documentation
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/latest/
📖
GettingStarted
https://docs.oracle.com/en/cloud/paas/goldengate-service/index.html
📖
Authentication
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm
📖
APIReference
https://docs.oracle.com/en-us/iaas/goldengate/doc/using-rest-api.html
📖
Documentation
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/
📖
APIReference
https://docs.oracle.com/en/middleware/fusion-middleware/osa/19.1/ggsa-rest-api/quick-start.html
📖
GettingStarted
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/
📖
Documentation
https://docs.oracle.com/en/database/goldengate/core/26/coredoc/distribute-datastream-rest-api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/openapi/oracle-goldengate-users-api-openapi.yml

Other Resources

🔗
Tutorials
https://docs.oracle.com/en/database/goldengate/core/26/tutorials.html
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/core/26/release-notes/
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/veridata/26/gvdrn/index.html
🔗
SDKs
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdks.htm
🔗
CLI
https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm
🔗
Tutorials
https://docs.oracle.com/en/cloud/paas/goldengate-service/tutorials.html
🔗
ChangeLog
https://docs.oracle.com/en-us/iaas/releasenotes/services/goldengate/
🔗
SDKs
https://docs.oracle.com/en-us/iaas/tools/python/latest/api/golden_gate.html
🔗
ChangeLog
https://docs.oracle.com/en/database/goldengate/stream-analytics/26/release-notes/release-notes-goldengate-stream-analytics.pdf

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/oracle-goldengate-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

oracle-goldengate-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Oracle Goldengate Users API
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-refined-note:
  - x-documentation differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Users across 3 of this provider''s published API definitions: oracle-goldengate-rest-api-openapi.yml, oracle-goldengate-stream-analytics-rest-api-openapi.yml, oracle-goldengate-veridata-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{goldengate-host}:{port}
  description: Oracle GoldenGate Microservices server
  variables:
    goldengate-host:
      default: localhost
      description: GoldenGate Microservices host
    port:
      default: '443'
      description: HTTPS port for the service
- url: https://{ggsa-host}:{port}/osa
  description: Oracle GoldenGate Stream Analytics server
  variables:
    ggsa-host:
      default: localhost
      description: GGSA server host
    port:
      default: '9080'
      description: GGSA HTTP/S port
- url: https://{veridata-host}:{port}/veridata/v1
  description: Oracle GoldenGate Veridata server
  variables:
    veridata-host:
      default: localhost
      description: Veridata server host
    port:
      default: '8830'
      description: Veridata HTTPS port
security:
- basicAuth: []
tags:
- name: Users
  description: User management and authorization
paths:
  /services/v2/authorizations:
    get:
      operationId: listUserRoles
      summary: Oracle Goldengate List User Roles
      description: Returns a list of available authorization roles.
      tags:
      - Users
      responses:
        '200':
          description: Roles listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleList'
              examples:
                Listuserroles200Example:
                  summary: Default listUserRoles 200 response
                  x-microcks-default: true
                  value:
                    roles:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/authorizations/{role}:
    get:
      operationId: listUsers
      summary: Oracle Goldengate List Users for a Role
      description: Returns a list of users assigned to a specific role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam'
      responses:
        '200':
          description: Users listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
              examples:
                Listusers200Example:
                  summary: Default listUsers 200 response
                  x-microcks-default: true
                  value:
                    users:
                    - name: Example Title
                      role: example_value
                      description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: bulkCreateUsers
      summary: Oracle Goldengate Bulk Create Users for a Role
      description: Creates multiple users with the specified role in a single operation.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateUsersRequest'
            examples:
              BulkcreateusersRequestExample:
                summary: Default bulkCreateUsers request
                x-microcks-default: true
                value:
                  users:
                  - name: Example Title
                    password: example_value
      responses:
        '201':
          description: Users created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
              examples:
                Bulkcreateusers201Example:
                  summary: Default bulkCreateUsers 201 response
                  x-microcks-default: true
                  value:
                    users:
                    - name: Example Title
                      role: example_value
                      description: A sample description.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/authorizations/{role}/{user}:
    get:
      operationId: getUser
      summary: Oracle Goldengate Retrieve a User
      description: Returns details of a specific user.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam'
      - $ref: '#/components/parameters/userParam'
      responses:
        '200':
          description: User details retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                Getuser200Example:
                  summary: Default getUser 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    role: example_value
                    description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createUser
      summary: Oracle Goldengate Create a User
      description: Creates a new user with the specified role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam'
      - $ref: '#/components/parameters/userParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
            examples:
              CreateuserRequestExample:
                summary: Default createUser request
                x-microcks-default: true
                value:
                  password: example_value
                  description: A sample description.
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                Createuser201Example:
                  summary: Default createUser 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    role: example_value
                    description: A sample description.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateUser
      summary: Oracle Goldengate Update a User
      description: Updates properties of an existing user.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam'
      - $ref: '#/components/parameters/userParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserRequest'
            examples:
              UpdateuserRequestExample:
                summary: Default updateUser request
                x-microcks-default: true
                value:
                  password: example_value
                  description: A sample description.
      responses:
        '200':
          description: User updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                Updateuser200Example:
                  summary: Default updateUser 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    role: example_value
                    description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteUser
      summary: Oracle Goldengate Delete a User
      description: Deletes a user from the system.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam'
      - $ref: '#/components/parameters/userParam'
      responses:
        '204':
          description: User deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v2/currentuser:
    get:
      operationId: getCurrentUser
      summary: Oracle Goldengate Retrieve Current User Information
      description: Returns information about the currently authenticated user.
      tags:
      - Users
      responses:
        '200':
          description: Current user information retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                Getcurrentuser200Example:
                  summary: Default getCurrentUser 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    role: example_value
                    description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: resetCurrentUserInfo
      summary: Oracle Goldengate Reset Current User Information
      description: Resets cached information for the current user.
      tags:
      - Users
      responses:
        '204':
          description: User information reset
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{goldengate-host}:{port}
      description: Oracle GoldenGate Microservices server
      variables:
        goldengate-host:
          default: localhost
          description: GoldenGate Microservices host
        port:
          default: '443'
          description: HTTPS port for the service
  /services/v1/authorizations/{role}:
    get:
      operationId: listUsers
      summary: Oracle Goldengate List Users for a Role
      description: Returns a list of all users assigned to a specific role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam_2'
      responses:
        '200':
          description: Users listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
              examples:
                Listusers200Example:
                  summary: Default listUsers 200 response
                  x-microcks-default: true
                  value:
                    users:
                    - name: Example Title
                      role: example_value
                      description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{ggsa-host}:{port}/osa
      description: Oracle GoldenGate Stream Analytics server
      variables:
        ggsa-host:
          default: localhost
          description: GGSA server host
        port:
          default: '9080'
          description: GGSA HTTP/S port
  /services/v1/authorizations/{role}/{user}:
    get:
      operationId: getUser
      summary: Oracle Goldengate Retrieve a User
      description: Returns details of a specific user in the given role.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam_2'
      - $ref: '#/components/parameters/userParam'
      responses:
        '200':
          description: User retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                Getuser200Example:
                  summary: Default getUser 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    role: example_value
                    description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createUser
      summary: Oracle Goldengate Create a User
      description: Creates a new user with the specified role for GGSA access.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam_2'
      - $ref: '#/components/parameters/userParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
            examples:
              CreateuserRequestExample:
                summary: Default createUser request
                x-microcks-default: true
                value:
                  password: example_value
                  description: A sample description.
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                Createuser201Example:
                  summary: Default createUser 201 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    role: example_value
                    description: A sample description.
        '400':
          $ref: '#/components/responses/BadRequest_2'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateUser
      summary: Oracle Goldengate Update a User
      description: Updates user properties or role assignment.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/roleParam_2'
      - $ref: '#/components/parameters/userParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserRequest'
            examples:
              UpdateuserRequestExample:
                summary: Default updateUser request
                x-microcks-default: true
                value:
                  password: example_value
                  description: A sample description.
      responses:
        '200':
          description: User updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                Updateuser200Example:
                  summary: Default updateUser 200 response
                  x-microcks-default: true
                  value:
                    name: Example Title
                    role: example_value
                    description: A sample description.
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{ggsa-host}:{port}/osa
      description: Oracle GoldenGate Stream Analytics server
      variables:
        ggsa-host:
          default: localhost
          description: GGSA server host
        port:
          default: '9080'
          description: GGSA HTTP/S port
  /services/admin/users:
    get:
      operationId: listUsers
      summary: Oracle Goldengate Retrieve All Users
      description: Returns a list of all Veridata users.
      tags:
      - Users
      responses:
        '200':
          description: Users listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserList'
              examples:
                Listusers200Example:
                  summary: Default listUsers 200 response
                  x-microcks-default: true
                  value:
                    users:
                    - id: abc123
                      username: example_value
                      firstName: example_value
                      lastName: example_value
                      email: user@example.com
                      role: example_value
                      userGroupId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createUser
      summary: Oracle Goldengate Create a User
      description: Creates a new Veridata user account.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest_2'
            examples:
              CreateuserRequestExample:
                summary: Default createUser request
                x-microcks-default: true
                value:
                  username: example_value
                  password: example_value
                  firstName: example_value
                  lastName: example_value
                  email: user@example.com
                  role: example_value
                  userGroupId: '500123'
      responses:
        '201':
          description: User created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_2'
              examples:
                Createuser201Example:
                  summary: Default createUser 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    username: example_value
                    firstName: example_value
                    lastName: example_value
                    email: user@example.com
                    role: example_value
                    userGroupId: '500123'
        '400':
          $ref: '#/components/responses/BadRequest_3'
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/admin/users/{Id}:
    get:
      operationId: getUser
      summary: Oracle Goldengate Retrieve a User
      description: Returns the details of a specific user.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userIdParam'
      responses:
        '200':
          description: User retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_2'
              examples:
                Getuser200Example:
                  summary: Default getUser 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    username: example_value
                    firstName: example_value
                    lastName: example_value
                    email: user@example.com
                    role: example_value
                    userGroupId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized_3'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: replaceUser
      summary: Oracle Goldengate Replace a User
      description: Replaces user account details.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceUserRequest'
            examples:
              ReplaceuserRequestExample:
                summary: Default replaceUser request
                x-microcks-default: true
                value:
                  firstName: example_value
                  lastName: example_value
                  email: user@example.com
                  role: example_value
                  userGroupId: '500123'
      responses:
        '200':
          description: User replaced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User_2'
              examples:
                Replaceuser200Example:
                  summary: Default replaceUser 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    username: example_value
                    firstName: example_value
                    lastName: example_value
                    email: user@example.com
                    role: example_value
                    userGroupId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized_3'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteUser
      summary: Oracle Goldengate Delete a User
      description: Deletes a Veridata user account.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userIdParam'
      responses:
        '204':
          description: User deleted
        '401':
          $ref: '#/components/responses/Unauthorized_3'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/admin/usergroups:
    get:
      operationId: listUserGroups
      summary: Oracle Goldengate Retrieve All User Groups
      description: Returns a list of all user groups.
      tags:
      - Users
      responses:
        '200':
          description: User groups listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupList'
              examples:
                Listusergroups200Example:
                  summary: Default listUserGroups 200 response
                  x-microcks-default: true
                  value:
                    userGroups:
                    - id: abc123
                      name: Example Title
                      description: A sample description.
                      permissions: {}
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createUserGroup
      summary: Oracle Goldengate Create a User Group
      description: Creates a new user group with specified permissions.
      tags:
      - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserGroupRequest'
            examples:
              CreateusergroupRequestExample:
                summary: Default createUserGroup request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  permissions:
                  - example_value
      responses:
        '201':
          description: User group created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
              examples:
                Createusergroup201Example:
                  summary: Default createUserGroup 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    permissions:
                    - example_value
        '400':
          $ref: '#/components/responses/BadRequest_3'
        '401':
          $ref: '#/components/responses/Unauthorized_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
  /services/admin/usergroups/{Id}:
    get:
      operationId: getUserGroup
      summary: Oracle Goldengate Retrieve a User Group
      description: Returns the details of a user group.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userGroupIdParam'
      responses:
        '200':
          description: User group retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
              examples:
                Getusergroup200Example:
                  summary: Default getUserGroup 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    permissions:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized_3'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: replaceUserGroup
      summary: Oracle Goldengate Replace a User Group
      description: Replaces a user group configuration.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userGroupIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplaceUserGroupRequest'
            examples:
              ReplaceusergroupRequestExample:
                summary: Default replaceUserGroup request
                x-microcks-default: true
                value:
                  name: Example Title
                  description: A sample description.
                  permissions:
                  - example_value
      responses:
        '200':
          description: User group replaced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroup'
              examples:
                Replaceusergroup200Example:
                  summary: Default replaceUserGroup 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    name: Example Title
                    description: A sample description.
                    permissions:
                    - example_value
        '401':
          $ref: '#/components/responses/Unauthorized_3'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteUserGroup
      summary: Oracle Goldengate Delete a User Group
      description: Deletes a user group.
      tags:
      - Users
      parameters:
      - $ref: '#/components/parameters/userGroupIdParam'
      responses:
        '204':
          description: User group deleted
        '401':
          $ref: '#/components/responses/Unauthorized_3'
        '404':
          $ref: '#/components/responses/NotFound_3'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://{veridata-host}:{port}/veridata/v1
      description: Oracle GoldenGate Veridata server
      variables:
        veridata-host:
          default: localhost
          description: Veridata server host
        port:
          default: '8830'
          description: Veridata HTTPS port
components:
  schemas:
    BulkCreateUsersRequest:
      type: object
      properties:
        users:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              password:
                type: string
                format: password
          example: []
    UserList:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
          example: []
    UpdateUserRequest:
      type: object
      properties:
        password:
          type: string
          format: password
          example: example_value
        description:
          type: string
          example: A sample description.
    User:
      type: object
      properties:
        name:
          type: string
          example: Example Title
        role:
          type: string
          example: example_value
        description:
          type: string
          example: A sample description.
    RoleList:
      type: object
      properties:
        roles:
          type: array
          items:
            type: string
          example: []
    CreateUserRequest:
      type: object
      required:
      - password
      properties:
        password:
          type: string
          format: password
          example: example_value
        description:
          type: string
          example: A sample description.
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code
          example: 10
        message:
          type: string
          description: Error message
          example: example_value
        severity:
          type: string
          description: Error severity level
          example: example_value
    ErrorResponse_2:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          exampl

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-goldengate/refs/heads/main/openapi/oracle-goldengate-users-api-openapi.yml