How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle GoldenGate Users API

User management and authorization

Oracle GoldenGate Users API is one of 37 APIs that Oracle GoldenGate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and an API reference.

This API exposes 23 operations across 10 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://{goldengate-host}:{port}, https://{ggsa-host}:{port}/osa, https://{veridata-host}:{port}/veridata/v1.

23 operations 10 paths 16 schemas 4 DELETE10 GET2 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://:/services/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Oracle GoldenGate Users API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication with GoldenGate user credentials

Paths & Operations 23

Across 10 paths, the API surfaces 23 operations — 4 DELETE, 10 GET, 2 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 23

User management and authorization

GET
/services/v2/authorizations
Oracle Goldengate List User Roles
listUserRoles → 200401
GET
/services/v2/authorizations/{role}
Oracle Goldengate List Users for a Role
listUsers 1 param → 200401
POST
/services/v2/authorizations/{role}
Oracle Goldengate Bulk Create Users for a Role
bulkCreateUsers 1 param body → 201400401
GET
/services/v2/authorizations/{role}/{user}
Oracle Goldengate Retrieve a User
getUser 2 params → 200401404
POST
/services/v2/authorizations/{role}/{user}
Oracle Goldengate Create a User
createUser 2 params body → 201400401
PATCH
/services/v2/authorizations/{role}/{user}
Oracle Goldengate Update a User
updateUser 2 params body → 200401404
DELETE
/services/v2/authorizations/{role}/{user}
Oracle Goldengate Delete a User
deleteUser 2 params → 204401404
GET
/services/v2/currentuser
Oracle Goldengate Retrieve Current User Information
getCurrentUser → 200401
DELETE
/services/v2/currentuser
Oracle Goldengate Reset Current User Information
resetCurrentUserInfo → 204401
GET
/services/v1/authorizations/{role}
Oracle Goldengate List Users for a Role
listUsers 1 param → 200401
GET
/services/v1/authorizations/{role}/{user}
Oracle Goldengate Retrieve a User
getUser 2 params → 200401404
POST
/services/v1/authorizations/{role}/{user}
Oracle Goldengate Create a User
createUser 2 params body → 201400401
PATCH
/services/v1/authorizations/{role}/{user}
Oracle Goldengate Update a User
updateUser 2 params body → 200401404
GET
/services/admin/users
Oracle Goldengate Retrieve All Users
listUsers → 200401
POST
/services/admin/users
Oracle Goldengate Create a User
createUser body → 201400401
GET
/services/admin/users/{Id}
Oracle Goldengate Retrieve a User
getUser 1 param → 200401404
PUT
/services/admin/users/{Id}
Oracle Goldengate Replace a User
replaceUser 1 param body → 200401404
DELETE
/services/admin/users/{Id}
Oracle Goldengate Delete a User
deleteUser 1 param → 204401404
GET
/services/admin/usergroups
Oracle Goldengate Retrieve All User Groups
listUserGroups → 200401
POST
/services/admin/usergroups
Oracle Goldengate Create a User Group
createUserGroup body → 201400401
GET
/services/admin/usergroups/{Id}
Oracle Goldengate Retrieve a User Group
getUserGroup 1 param → 200401404
PUT
/services/admin/usergroups/{Id}
Oracle Goldengate Replace a User Group
replaceUserGroup 1 param body → 200401404
DELETE
/services/admin/usergroups/{Id}
Oracle Goldengate Delete a User Group
deleteUserGroup 1 param → 204401404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are User_2 (7 properties), CreateUserRequest_2 (7 properties), ReplaceUserRequest (5 properties), UserGroup (4 properties). Each schema is shown below with its type and property counts.

BulkCreateUsersRequest
object
1 property
UserList
object
1 property
UpdateUserRequest
object
2 properties
User
object
3 properties
RoleList
object
1 property
CreateUserRequest
object
2 properties 1 required
ErrorResponse
object
3 properties
ErrorResponse_2
object
2 properties
User_2
object
7 properties
ReplaceUserRequest
object
5 properties
CreateUserGroupRequest
object
3 properties 1 required
CreateUserRequest_2
object
7 properties 2 required
ErrorResponse_3
object
2 properties
UserGroupList
object
1 property
ReplaceUserGroupRequest
object
3 properties
UserGroup
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-goldengate-users-api-openapi.yml Raw ↑

Other APIs Oracle GoldenGate publishes across the network.

Oracle GoldenGate Artifacts API
Oracle GoldenGate AsyncAPI API
Oracle GoldenGate Certificates API
Oracle GoldenGate Commands API
Oracle GoldenGate Compare Pairs API
Oracle GoldenGate Configuration API
Oracle GoldenGate Connection Assignments API
Oracle GoldenGate Connections API
Oracle GoldenGate Credentials API
Oracle GoldenGate Data Streams API
Oracle GoldenGate Data Targets API
Oracle GoldenGate Database Registrations API
Where this information came from

This is an independent, third-party profile of Oracle GoldenGate Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.