mammoth-io OAuth Client API

openapi: 3.2.0
info:
  title: Mammoth Io OAuth Client API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged OAuth Client 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: OAuth Client
paths:
  /workspaces/{workspace_id}/oauth-clients/{oauth_client_id}:
    delete:
      tags:
      - OAuth Client
      summary: Delete an OAuth client registration
      description: Deletes the client registration and every connection users made to it, so its tokens stop working.
      operationId: DeleteOauthClient
      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: oauth_client_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: OAuth Client ID
          description: ID of the OAuth client
          examples:
          - 1
        description: ID of the OAuth client
        required: true
        deprecated: false
        examples:
          oauth_client_id-example-1:
            value: 1
      responses:
        '204':
          description: Successful delete
        '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: {}
        '404':
          description: Not found
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
  /workspaces/{workspace_id}/oauth-clients/{oauth_client_id}/grant:
    delete:
      tags:
      - OAuth Client
      summary: Disconnect a third-party OAuth client from your account
      description: Removes the requesting user's connection to this client (same as removing it under Settings -> Connected apps). Takes effect on the client's very next call. Does not require workspace-admin permission and does not delete the client registration.
      operationId: RevokeOauthGrant
      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: oauth_client_id
        in: path
        schema:
          type: integer
          minimum: 1.0
          title: OAuth Client ID
          description: ID of the OAuth client
          examples:
          - 1
        description: ID of the OAuth client
        required: true
        deprecated: false
        examples:
          oauth_client_id-example-1:
            value: 1
      responses:
        '204':
          description: Grant revoked
        '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: {}
        '404':
          description: Not found
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  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