mammoth-io Registration Support API

openapi: 3.2.0
info:
  title: Mammoth Io Registration Support API
  version: 0.1.0
  contact:
    name: Mammoth Analytics
    url: https://mammoth.io
    email: support@mammoth.io
  description: 'Operations tagged Registration Support 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: Registration Support
paths:
  /support/users:
    post:
      tags:
      - Registration Support
      summary: Register a user
      description: Register a user with the given details
      operationId: RegisterUser
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterUserPostSchema'
        required: true
      responses:
        '201':
          description: Document created, URL follows
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterResponseSchema'
        '400':
          description: Bad Request
        '200':
          description: Successful patch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterResponseSchema'
        '401':
          description: Authorization error
      deprecated: false
    patch:
      tags:
      - Registration Support
      summary: Update user details
      operationId: UpdateUserVerification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterUserPatches'
        required: true
      responses:
        '200':
          description: Successful patch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterResponseSchema'
        '400':
          description: Bad Request
        '401':
          description: Authorization error
      deprecated: false
    servers:
    - url: /api/v2
components:
  schemas:
    RegisterUserPostSchema:
      properties:
        email:
          type: string
          format: email
          title: Email of the user
          description: Email of the customer
          examples:
          - value: test@gmail.com
        first_name:
          type: string
          title: First Name
          description: First Name of the user to register
          examples:
          - Sample First Name
        last_name:
          type: string
          title: Last Name
          description: Last Name of the user to register
          examples:
          - Sample Last Name
        verified:
          type: boolean
          title: Verified
          description: Verified status of the user
          examples:
          - false
        is_registration:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Is registration
          description: Is post request from registration
          examples:
          - value: false
      type: object
      required:
      - email
      - first_name
      - last_name
      - verified
      title: RegisterUserPostSchema
      description: Details of the user to be registered
      examples:
      - first_name: John
        last_name: Smith
        email: johnsmith@exmaple.io
        verified: false
    RegisterUserPatchSchema:
      properties:
        op:
          type: string
          title: Operation
          description: Operation to be performed on the user
          examples:
          - summary: Sample Operation
            value: replace
        path:
          type: string
          title: Path
          description: Path of the user
          examples:
          - summary: Sample Path
            value: verified
        value:
          oneOf:
          - $ref: '#/components/schemas/RegisterPatchValueSchema'
          - type: string
      type: object
      required:
      - op
      - path
      - value
      title: RegisterUserPatchSchema
    RegisterResponseSchema:
      properties:
        user_id:
          type: integer
          exclusiveMinimum: 0.0
          title: User ID
          description: ID of the user
          examples:
          - summary: Registered user id
            value: 2
        verified:
          type: boolean
          title: Verified
          description: Verified status of the user
          examples:
          - summary: Is user verified
            value: false
      type: object
      required:
      - user_id
      - verified
      title: RegisterResponseSchema
    RegisterUserPatches:
      properties:
        patch:
          items:
            $ref: '#/components/schemas/RegisterUserPatchSchema'
          type: array
      type: object
      required:
      - patch
      title: RegisterUserPatches
      description: Details of the user to be updated
      examples:
      - patch:
        - op: replace
          path: verified
          value:
            email: johnsmith@exmaple.io
            verified: true
    RegisterPatchValueSchema:
      properties:
        email:
          type: string
          format: email
          title: Email of the user
          description: Email of the customer
          examples:
          - value: test@gmail.com
        verified:
          type: boolean
          title: Verified
          description: Verified status of the user to be updated
          examples:
          - summary: Is registered user verified
            value: false
        is_registration:
          oneOf:
          - type: boolean
          - type: 'null'
          title: Is registrations
          description: Is patch request from registration
          examples:
          - value: false
      type: object
      required:
      - email
      - verified
      title: RegisterPatchValueSchema
  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