Appmixer Users API

User account management

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

appmixer-users-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Appmixer Accounts Users API
  description: The Appmixer REST API provides programmatic access to manage workflows, users, accounts, apps/connectors, files, data stores, insights, and people tasks within the Appmixer embedded iPaaS platform. The API allows you to access all the features that the Appmixer UI works with.
  version: 6.1.0
  contact:
    name: Appmixer
    url: https://www.appmixer.com/
  license:
    name: Proprietary
    url: https://www.appmixer.com/terms-and-conditions
servers:
- url: https://api.{tenant}.appmixer.cloud
  description: Appmixer Cloud Tenant API
  variables:
    tenant:
      default: YOUR_TENANT
      description: Your Appmixer tenant identifier
security:
- bearerAuth: []
tags:
- name: Users
  description: User account management
paths:
  /user:
    get:
      operationId: getCurrentUser
      summary: Appmixer Get current user
      description: Get information about the currently authenticated user.
      responses:
        '200':
          description: User information returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized
      tags:
      - Users
    post:
      operationId: createUser
      summary: Appmixer Create a new user
      description: Create a new Appmixer user account. By default, this endpoint is open and does not require authentication.
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - username
              - password
              properties:
                username:
                  type: string
                  description: The user's email address
                password:
                  type: string
                  description: The user's password
      responses:
        '200':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Invalid request
      tags:
      - Users
  /users/{userId}:
    put:
      operationId: updateUser
      summary: Appmixer Update a user
      description: Update user information for the specified user.
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                username:
                  type: string
                password:
                  type: string
      responses:
        '200':
          description: User updated successfully
        '401':
          description: Unauthorized
        '404':
          description: User not found
      tags:
      - Users
    delete:
      operationId: deleteUser
      summary: Appmixer Delete a user
      description: Delete the specified user account.
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: User deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: User not found
      tags:
      - Users
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
        username:
          type: string
        email:
          type: string
        token:
          type: string
        plan:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Access token obtained from the /user/auth endpoint. Pass as Authorization: Bearer {token} header.'