openapi: 3.1.0
info:
  title: Oracle GoldenGate for Big Data REST Artifacts Credentials API
  description: REST API for managing Oracle GoldenGate for Big Data deployments via the Microservices Architecture. Enables configuration and monitoring of replication to big data targets including Apache Kafka, HDFS, HBase, Cassandra, MongoDB, Elasticsearch, and cloud object stores. Uses the same Microservices Architecture REST API base as the core GoldenGate product with big data-specific replicat handlers and data target types.
  version: 21.3.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-documentation:
  - url: https://docs.oracle.com/en/middleware/goldengate/big-data/21.3/gadbd/index.html
    description: Oracle GoldenGate for Big Data Administration Guide
servers:
- url: https://{goldengate-host}:{port}
  description: Oracle GoldenGate for Big Data Microservices server
  variables:
    goldengate-host:
      default: localhost
      description: GoldenGate Big Data host
    port:
      default: '443'
      description: HTTPS port
security:
- basicAuth: []
tags:
- name: Credentials
  description: Manage credential store for big data target connections
paths:
  /services/v2/credentials:
    get:
      operationId: listCredentialDomains
      summary: Oracle Goldengate List Credential Domains
      description: Returns all credential store domains used for big data target authentication.
      tags:
      - Credentials
      responses:
        '200':
          description: Domains listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialDomainList'
              examples:
                Listcredentialdomains200Example:
                  summary: Default listCredentialDomains 200 response
                  x-microcks-default: true
                  value:
                    domains:
                    - name: Example Title
                      aliasCount: 10
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/credentials/{domain}/{alias}:
    get:
      operationId: getCredentialAlias
      summary: Oracle Goldengate Retrieve a Credential Alias
      description: Returns a credential alias used for target system authentication.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      responses:
        '200':
          description: Alias retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAlias'
              examples:
                Getcredentialalias200Example:
                  summary: Default getCredentialAlias 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    alias: example_value
                    userid: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createCredentialAlias
      summary: Oracle Goldengate Create a Credential Alias
      description: Creates a credential alias for authenticating with big data targets.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
            examples:
              CreatecredentialaliasRequestExample:
                summary: Default createCredentialAlias request
                x-microcks-default: true
                value:
                  userid: '500123'
                  password: example_value
      responses:
        '201':
          description: Alias created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAlias'
              examples:
                Createcredentialalias201Example:
                  summary: Default createCredentialAlias 201 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    alias: example_value
                    userid: '500123'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: replaceCredentialAlias
      summary: Oracle Goldengate Replace a Credential Alias
      description: Replaces an existing credential alias.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
            examples:
              ReplacecredentialaliasRequestExample:
                summary: Default replaceCredentialAlias request
                x-microcks-default: true
                value:
                  userid: '500123'
                  password: example_value
      responses:
        '200':
          description: Alias replaced
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAlias'
              examples:
                Replacecredentialalias200Example:
                  summary: Default replaceCredentialAlias 200 response
                  x-microcks-default: true
                  value:
                    domain: example_value
                    alias: example_value
                    userid: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteCredentialAlias
      summary: Oracle Goldengate Delete a Credential Alias
      description: Deletes a credential alias.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam'
      - $ref: '#/components/parameters/aliasParam'
      responses:
        '204':
          description: Alias deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/credentials/{domain}:
    get:
      operationId: listDomainAliases
      summary: Oracle Goldengate List Aliases in a Credential Domain
      description: Returns all credential aliases within a specified domain.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam_2'
      responses:
        '200':
          description: Aliases listed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialAliasList'
              examples:
                Listdomainaliases200Example:
                  summary: Default listDomainAliases 200 response
                  x-microcks-default: true
                  value:
                    aliases:
                    - domain: example_value
                      alias: example_value
                      userid: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /services/v2/credentials/{domain}/{alias}/valid:
    get:
      operationId: validateCredentialAlias
      summary: Oracle Goldengate Validate a Credential Alias
      description: Validates that a credential alias can successfully connect to its target.
      tags:
      - Credentials
      parameters:
      - $ref: '#/components/parameters/domainParam_2'
      - $ref: '#/components/parameters/aliasParam'
      responses:
        '200':
          description: Validation result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationResult'
              examples:
                Validatecredentialalias200Example:
                  summary: Default validateCredentialAlias 200 response
                  x-microcks-default: true
                  value:
                    valid: '500123'
                    message: example_value
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '404':
          $ref: '#/components/responses/NotFound_2'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    CredentialAlias:
      type: object
      properties:
        domain:
          type: string
          example: example_value
        alias:
          type: string
          example: example_value
        userid:
          type: string
          example: '500123'
    CreateCredentialRequest:
      type: object
      required:
      - userid
      - password
      properties:
        userid:
          type: string
          example: '500123'
        password:
          type: string
          format: password
          example: example_value
    ValidationResult:
      type: object
      properties:
        valid:
          type: boolean
          example: '500123'
        message:
          type: string
          example: example_value
    CredentialDomainList:
      type: object
      properties:
        domains:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              aliasCount:
                type: integer
          example: []
    CredentialAliasList:
      type: object
      properties:
        aliases:
          type: array
          items:
            $ref: '#/components/schemas/CredentialAlias'
          example: []
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
        severity:
          type: string
          example: example_value
    ErrorResponse_2:
      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
  parameters:
    domainParam:
      name: domain
      in: path
      required: true
      description: Credential store domain
      schema:
        type: string
    aliasParam:
      name: alias
      in: path
      required: true
      description: Credential alias name
      schema:
        type: string
    domainParam_2:
      name: domain
      in: path
      required: true
      description: Credential store domain name
      schema:
        type: string
  responses:
    Unauthorized_2:
      description: Authentication required or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
    NotFound_2:
      description: The requested resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse_2'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic