mammoth-io Publish Credentials API

openapi: 3.2.0
info:
  title: Mammoth Io Publish Credentials API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Publish Credentials across 2 of this provider''s published API definitions: app.mammoth.io-openapi.json, mammoth-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v2
security:
- bearerAuth: []
- apiKey: []
  apiSecret: []
  workspaceId: []
tags:
- name: Publish Credentials
paths:
  /workspaces/{workspace_id}/projects/{project_id}/credentials:
    get:
      tags:
      - Publish Credentials
      summary: Get Publish Credentials
      description: Retrieve publish credentials for a given ODBC type and project ID
      operationId: GetPublishCredentials
      parameters:
      - name: workspace_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Workspace ID
          description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
          examples:
          - 4
        description: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
        required: true
        deprecated: false
        examples:
          workspace_id-example-1:
            summary: Sample workspace ID
            value: 4
      - name: project_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: Project ID
          description: Project ID of the workspace
          examples:
          - 4
        description: Project ID of the workspace
        required: true
        deprecated: false
        examples:
          project_id-example-1:
            summary: Sample project ID
            value: 4
      - name: odbc_type
        in: query
        schema:
          $ref: '#/components/schemas/OdbcTypes'
        description: ODBC Type for the connection
        required: true
        deprecated: false
        allowEmptyValue: false
        allowReserved: false
        examples:
          odbc_type-example-1:
            summary: Sample ODBC Type
            value: postgres
      responses:
        '200':
          description: Get Publish Credentials Success
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/BigqueryPublishCredsSchema'
                - $ref: '#/components/schemas/PostgresPublishCredsSchema'
        '400':
          description: Bad Request
        '403':
          description: Request forbidden -- authorization will not help
          content:
            application/json:
              schema:
                properties:
                  status_code:
                    type: integer
                  detail:
                    type: string
                  extra:
                    additionalProperties: {}
                    type:
                    - 'null'
                    - object
                    - array
                type: object
                required:
                - detail
                - status_code
                description: Authorization Exception
                examples:
                - status_code: 403
                  detail: Forbidden
                  extra: {}
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    PostgresPublishCredsSchema:
      properties:
        database:
          type: string
          title: Database
          description: Database name
          examples:
          - summary: Sample Database
            value: my_database
        host_ip:
          type: string
          title: Host IP
          description: Host IP address
          examples:
          - value: ''
        port:
          type: integer
          title: Port
          description: Port number
          examples:
          - summary: Sample Port
            value: 5432
        username:
          type: string
          title: Username
          description: Username for the connection
          examples:
          - summary: Sample Username
            value: admin
        password:
          type: string
          title: Password
          description: Password for the connection
          examples:
          - summary: Sample Password
            value: admin
      type: object
      required:
      - database
      - host_ip
      - password
      - port
      - username
      title: PostgresPublishCredsSchema
    OdbcTypes:
      type: string
      enum:
      - postgres
      - bigquery
      minLength: 1
      title: OdbcTypes
      description: ODBC Type for the connection
      examples:
      - summary: Sample ODBC Type
        value: postgres
    ServiceAccountJsonSchema:
      properties:
        type:
          type: string
          minLength: 1
          title: Type
          description: Type of the service account
          examples:
          - summary: Sample Type
            value: service_account
        project_id:
          type: string
          minLength: 1
          title: Project ID
          description: Project ID of the service account
          examples:
          - summary: Sample Project ID
            value: server-bq-test
        client_email:
          type: string
          minLength: 1
          title: Client Email
          description: Client email of the service account
          examples:
          - summary: Sample Client Email
            value: client@email
        auth_uri:
          type: string
          minLength: 1
          title: Auth URI
          description: Auth URI of the service account
          examples:
          - summary: Sample Auth URI
            value: https://accounts.google.com/o/oauth2/auth
        token_uri:
          type: string
          minLength: 1
          title: Token URI
          description: Token URI of the service account
          examples:
          - summary: Sample Token URI
            value: https://oauth2.googleapis.com/token
        auth_provider_x509_cert_url:
          type: string
          minLength: 1
          title: Auth Provider X509 Cert URL
          description: Auth Provider X509 Cert URL of the service account
          examples:
          - summary: Sample Auth Provider X509 Cert URL
            value: https://www.googleapis.com/oauth2/v1/certs
        client_x509_cert_url:
          type: string
          minLength: 1
          title: Client X509 Cert URL
          description: Client X509 Cert URL of the service account
          examples:
          - summary: Sample Client X509 Cert URL
            value: https://www.googleapis.com/robot/v1/metadata/x509/mm-dv-mm.com
        universe_domain:
          type: string
          minLength: 1
          title: Universe Domain
          description: Universe Domain of the service account
          examples:
          - summary: Sample Universe Domain
            value: googleapis.com
      type: object
      required:
      - auth_provider_x509_cert_url
      - auth_uri
      - client_email
      - client_x509_cert_url
      - project_id
      - token_uri
      - type
      - universe_domain
      title: ServiceAccountJsonSchema
    BigqueryPublishCredsSchema:
      properties:
        dataset:
          type: string
          minLength: 1
          title: Dataset
          description: Dataset name
          examples:
          - summary: Sample Dataset
            value: my_dataset
        service_account_json:
          oneOf:
          - $ref: '#/components/schemas/ServiceAccountJsonSchema'
          - type: 'null'
          title: Service Account JSON
          description: Service account JSON details
          examples:
          - summary: Sample Service Account JSON
            value:
              type: service_account
              project_id: abc-project
        service_account_json_url:
          type: string
          title: Service Account JSON URL
          description: URL for the service account JSON
          examples:
          - summary: Sample Service Account JSON URL
            value: https://signed_url.com/service_account.json
      type: object
      required:
      - dataset
      - service_account_json_url
      title: BigqueryPublishCredsSchema
  securitySchemes:
    bearerAuth:
      type: http
      description: 'Primary credential. Authorization: Bearer mm_<token>. The token is issued server-side and shown once at creation.'
      scheme: bearer
    apiKey:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-KEY
      in: header
    apiSecret:
      type: apiKey
      description: Deprecated — use bearerAuth.
      name: X-API-SECRET
      in: header
    workspaceId:
      type: apiKey
      description: Required with X-API-KEY and X-API-SECRET. Deprecated with them — use bearerAuth.
      name: X-WORKSPACE-ID
      in: header
x-refined-from:
- app.mammoth.io-openapi.json
- mammoth-io-openapi.json