ECI Solutions

ECI Solutions API User API

The API User API from ECI Solutions — 15 operation(s) for api user.

GitHub OpenAPI

Operations 21

POST /api/api-users Register the API Users by Global Admin, Product Admin, Company Manager #
PATCH /api/api-users/{clientId}/external-connection Update Connection Properties #
GET /api/api-users/{userId} This API is used to get the details of the API User and their associated… #
PUT /api/api-users/{userId} Update first or last name of the API User and its property settings #
PATCH /api/api-users/{userId} To change the status of API User by Global Admin, Product Admin and Company… #
DELETE /api/api-users/{userId} This API is used to delete the API Users #
POST /api/api-users/{userId}/activity Updates the last activity date/time for the Company and API Credential and… #
POST /api/api-users/{userId}/confirm Confirm pending API User manually, if API User has not received verification… #
POST /api/api-users/{userId}/resend_link This API is used to resend verification link for the API User who has… #
POST /api/api-users/login This API authenticates the user credentials #
POST /api/api-users/test-connection Check connectivity with the integration's system using the provided settings #
POST /api/ApiUser Register the API Users by Global Admin, Product Admin, Company Manager #
GET /api/ApiUser/{userId} This API is used to get the details of the API User and their associated… #
PUT /api/ApiUser/{userId} Update first or last name of the API User and its property settings #
PATCH /api/ApiUser/{userId} To change the status of API User by Global Admin, Product Admin and Company… #
DELETE /api/ApiUser/{userId} This API is used to delete the API Users #
POST /api/ApiUser/{userId}/activity Updates the last activity date/time for the Company and API Credential and… #
POST /api/ApiUser/{userId}/confirm Confirm pending API User manually, if API User has not received verification… #
POST /api/ApiUser/{userId}/resend_link This API is used to resend verification link for the API User who has… #
POST /api/ApiUser/login This API authenticates the user credentials #
POST /api/ApiUser/test-connection Check connectivity with the integration's system using the provided settings #

Documentation

📖
APIReference
https://integrations.ecimanufacturing.com/api.html?family=erp
📖
Documentation
https://integrations.ecimanufacturing.com/
📖
APIReference
https://integrations.ecimanufacturing.com/api.html?family=jb2
📖
APIReference
https://integrations.ecimanufacturing.com/api.html?family=m1
📖
APIReference
https://integrations.ecimanufacturing.com/api.html?id=management-v1
📖
APIReference
https://integrations.ecimanufacturing.com/authenticate.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/authentication/eci-solutions-authentication.yml
📖
APIReference
https://platform.lassocrm.com/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/openapi/eci-solutions-api-user-api-openapi.yml

Other Resources

🔗
Support
https://www.ecisolutions.com/support/
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/scopes/eci-solutions-scopes.yml
🔗
OpenIDConnect
https://cognito-idp.us-east-1.amazonaws.com/us-east-1_9IYBf4TpD/.well-known/openid-configuration
🔗
ChangeLog
https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/changelog/eci-solutions-changelog.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/asyncapi/eci-solutions-lasso-registrant-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/eci-solutions-api-user-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

eci-solutions-api-user-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: MFG Integration Management API User API
  description: Provides APIs for managing ECI MFG Integration Engine Configurations.
  contact:
    name: ECI Manufacturing Integration Team
    url: https://www.ecisolutions.com/support/
  version: 2.22.273+b02c1dfd00
servers:
- url: https://api-user.integrations.ecimanufacturing.com:443
  description: Production
security:
- oidc:
  - openid
- Basic: []
tags:
- name: API User
paths:
  /api/api-users:
    post:
      tags:
      - API User
      summary: Register the API Users by Global Admin, Product Admin, Company Manager
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI, Payment Integration.\

        Description: This API registers all API Users by Global Admin, Product Admin and Product Support User.

        Using Company Manager, it registers only the ERP, NET1, Avalara and JobBOSS2 public API Users except the financial API Users.'
      operationId: RegisterApiUser
      requestBody:
        description: This is an object which contains all required and optional fields to register the API Users
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ErpApiUser'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ErpApiUser'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ErpApiUser'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
  /api/api-users/{clientId}/external-connection:
    patch:
      tags:
      - API User
      summary: Update Connection Properties
      description: 'Updates the master key values for the connection associated with the given API Credential

        Client ID and applies those settings to the API credential.


        This method can only be invoked by the original creator of the connection.'
      operationId: UpdateConnectionProperties
      parameters:
      - name: clientId
        in: path
        description: The API Credential Client ID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateConnectionModel'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateConnectionModel'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateConnectionModel'
      responses:
        '204':
          description: No Content
  /api/api-users/{userId}:
    get:
      tags:
      - API User
      summary: This API is used to get the details of the API User and their associated…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: Global Admin can get the details of all the API Users.

        Product Admin can get only those API Users'' details, whom they can access.'
      operationId: GetApiUserDetailsById
      parameters:
      - name: userId
        in: path
        description: UserId of API User and is required in Guid
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
    put:
      tags:
      - API User
      summary: Update first or last name of the API User and its property settings
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: This API is used to update the first or last name of API Users in database and cognito too.

        And Erpsetting values of API Users in database.'
      operationId: UpdateApiUser
      parameters:
      - name: userId
        in: path
        description: The API User id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: This is an object which contains some required and optional field
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateApiUserRequestModel'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateApiUserRequestModel'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateApiUserRequestModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
    patch:
      tags:
      - API User
      summary: To change the status of API User by Global Admin, Product Admin and Company…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: This API is used to change the status from active to inactive and vice-versa of any API User by Global Admin, Product Admin and Company Manager.'
      operationId: UserStatusApiUser
      parameters:
      - name: userId
        in: path
        description: User ID of API User and this field is required in GUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: The only property isActive with a value of true to activate the account or false to deactivate the account.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ToggleEntityModel'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ToggleEntityModel'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ToggleEntityModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
    delete:
      tags:
      - API User
      summary: This API is used to delete the API Users
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: It Hard delete the API Users details from database and cognito.'
      operationId: DeleteApiUser
      parameters:
      - name: userId
        in: path
        description: The userId of API Users which we want to delete and it is required in GUID format.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
  /api/api-users/{userId}/activity:
    post:
      tags:
      - API User
      summary: Updates the last activity date/time for the Company and API Credential and…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Financial Admin, Company Manager.\

        Accessed From: User Mgmt UI, Payment Integration, Financial Integration, ERP Integration, Avatax Integration.\

        Description: This method is typically used by integrations to obtain API Credential integration details.'
      operationId: UpdateApiUserLastActivity
      parameters:
      - name: userId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiUserResponseModelAPIResponse'
  /api/api-users/{userId}/confirm:
    post:
      tags:
      - API User
      summary: Confirm pending API User manually, if API User has not received verification…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: Confirm pending API User manually, if API User has not received verification mail.'
      operationId: ConfirmApiUser
      parameters:
      - name: userId
        in: path
        description: User ID of API User and this filed is required in GUID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
  /api/api-users/{userId}/resend_link:
    post:
      tags:
      - API User
      summary: This API is used to resend verification link for the API User who has…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI, Payment Integration.\

        Description: Used to resend verification link for the API User who has Enablepasswordreset set to "TRUE".'
      operationId: ResendLinkApiUser
      parameters:
      - name: userId
        in: path
        description: The unique Guid user Id of the API User
        required: true
        schema:
          type: string
          format: uuid
      - name: userName
        in: query
        description: The unique username of the API User (optional)
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
  /api/api-users/login:
    post:
      tags:
      - API User
      summary: This API authenticates the user credentials
      description: 'Accessible By: Everyone can use this API because it''s Anonymous.\

        Accessed From: User Mgmt UI, Payment Integration.\

        Description: This API authenticates the user credentials. After successful authentication, it returns AWS cognito tokens.'
      operationId: LoginApiUser
      requestBody:
        description: This is an object which contains username and password and both are required.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuthenticateAPIUser'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuthenticateAPIUser'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuthenticateAPIUser'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AuthenticateUserResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticateUserResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AuthenticateUserResponseAPIResponse'
  /api/api-users/test-connection:
    post:
      tags:
      - API User
      summary: Check connectivity with the integration's system using the provided settings
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: Check connectivity with the integration''s system using the provided settings.'
      operationId: TestConnectionApiUser
      parameters:
      - name: system_Id
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TestConnectionRequestModel'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TestConnectionRequestModel'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TestConnectionRequestModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TestConnectionResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectionResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TestConnectionResponseModelAPIResponse'
  /api/ApiUser:
    post:
      tags:
      - API User
      summary: Register the API Users by Global Admin, Product Admin, Company Manager
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI, Payment Integration.\

        Description: This API registers all API Users by Global Admin, Product Admin and Product Support User.

        Using Company Manager, it registers only the ERP, NET1, Avalara and JobBOSS2 public API Users except the financial API Users.'
      operationId: RegisterApiUser
      requestBody:
        description: This is an object which contains all required and optional fields to register the API Users
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ErpApiUser'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ErpApiUser'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ErpApiUser'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
  /api/ApiUser/{userId}:
    get:
      tags:
      - API User
      summary: This API is used to get the details of the API User and their associated…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: Global Admin can get the details of all the API Users.

        Product Admin can get only those API Users'' details, whom they can access.'
      operationId: GetApiUserDetailsById
      parameters:
      - name: userId
        in: path
        description: UserId of API User and is required in Guid
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
    put:
      tags:
      - API User
      summary: Update first or last name of the API User and its property settings
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: This API is used to update the first or last name of API Users in database and cognito too.

        And Erpsetting values of API Users in database.'
      operationId: UpdateApiUser
      parameters:
      - name: userId
        in: path
        description: The API User id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: This is an object which contains some required and optional field
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateApiUserRequestModel'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateApiUserRequestModel'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateApiUserRequestModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
    patch:
      tags:
      - API User
      summary: To change the status of API User by Global Admin, Product Admin and Company…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: This API is used to change the status from active to inactive and vice-versa of any API User by Global Admin, Product Admin and Company Manager.'
      operationId: UserStatusApiUser
      parameters:
      - name: userId
        in: path
        description: User ID of API User and this field is required in GUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        description: The only property isActive with a value of true to activate the account or false to deactivate the account.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ToggleEntityModel'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ToggleEntityModel'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ToggleEntityModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
    delete:
      tags:
      - API User
      summary: This API is used to delete the API Users
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: It Hard delete the API Users details from database and cognito.'
      operationId: DeleteApiUser
      parameters:
      - name: userId
        in: path
        description: The userId of API Users which we want to delete and it is required in GUID format.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
  /api/ApiUser/{userId}/activity:
    post:
      tags:
      - API User
      summary: Updates the last activity date/time for the Company and API Credential and…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Financial Admin, Company Manager.\

        Accessed From: User Mgmt UI, Payment Integration, Financial Integration, ERP Integration, Avatax Integration.\

        Description: This method is typically used by integrations to obtain API Credential integration details.'
      operationId: UpdateApiUserLastActivity
      parameters:
      - name: userId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ApiUserResponseModelAPIResponse'
  /api/ApiUser/{userId}/confirm:
    post:
      tags:
      - API User
      summary: Confirm pending API User manually, if API User has not received verification…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: Confirm pending API User manually, if API User has not received verification mail.'
      operationId: ConfirmApiUser
      parameters:
      - name: userId
        in: path
        description: User ID of API User and this filed is required in GUID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetApiUserResponseModelAPIResponse'
  /api/ApiUser/{userId}/resend_link:
    post:
      tags:
      - API User
      summary: This API is used to resend verification link for the API User who has…
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI, Payment Integration.\

        Description: Used to resend verification link for the API User who has Enablepasswordreset set to "TRUE".'
      operationId: ResendLinkApiUser
      parameters:
      - name: userId
        in: path
        description: The unique Guid user Id of the API User
        required: true
        schema:
          type: string
          format: uuid
      - name: userName
        in: query
        description: The unique username of the API User (optional)
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
  /api/ApiUser/login:
    post:
      tags:
      - API User
      summary: This API authenticates the user credentials
      description: 'Accessible By: Everyone can use this API because it''s Anonymous.\

        Accessed From: User Mgmt UI, Payment Integration.\

        Description: This API authenticates the user credentials. After successful authentication, it returns AWS cognito tokens.'
      operationId: LoginApiUser
      requestBody:
        description: This is an object which contains username and password and both are required.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuthenticateAPIUser'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuthenticateAPIUser'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AuthenticateAPIUser'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/AuthenticateUserResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticateUserResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AuthenticateUserResponseAPIResponse'
  /api/ApiUser/test-connection:
    post:
      tags:
      - API User
      summary: Check connectivity with the integration's system using the provided settings
      description: 'Accessible By: Global Admin, Product Admin, Product Support User, Company Manager.\

        Accessed From: User Mgmt UI.\

        Description: Check connectivity with the integration''s system using the provided settings.'
      operationId: TestConnectionApiUser
      parameters:
      - name: system_Id
        in: query
        description: ''
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TestConnectionRequestModel'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TestConnectionRequestModel'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TestConnectionRequestModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/TestConnectionResponseModelAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectionResponseModelAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/TestConnectionResponseModelAPIResponse'
components:
  schemas:
    UpdateApiUserRequestModel:
      required:
      - firstName
      - username
      type: object
      properties:
        username:
          minLength: 1
          type: string
        firstName:
          minLength: 1
          type: string
        lastName:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        keyIds:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        isPasswordChanged:
          type: boolean
        companyId:
          type: integer
          format: int32
        financialCompanyId:
          type: integer
          format: int32
        userType:
          type: integer
          format: int32
        expireType:
          type: integer
          format: int32
        days:
          type:
          - integer
          - 'null'
          format: int32
        expireDateTime:
          type:
          - string
          - 'null'
        environment:
          type:
          - string
          - 'null'
      additionalProperties: false
    ValidationError:
      type: object
      properties:
        field:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    AuthenticateUserResponseAPIResponse:
      type: object
      properties:
        version:
          type:
          - string
          - 'null'
        statusCode:
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        responseException:
          allOf:
          - $ref: '#/components/schemas/ApiError'
        result:
          allOf:
          - $ref: '#/components/schemas/AuthenticateUserResponse'
      additionalProperties: false
    ApiUserResponseModelAPIResponse:
      type: object
      properties:
        version:
          type:
          - string
          - 'null'
        statusCode:
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        responseException:
          allOf:
          - $ref: '#/components/schemas/ApiError'
        result:
          allOf:
          - $ref: '#/components/schemas/ApiUserResponseModel'
      additionalProperties: false
    FinancialIntegrationApiUserProperties:
      type: object
      properties:
        financialCompanyId:
          type:
          - integer
          - 'null'
          format: int32
        financialCompanyName:
          type:
          - string
          - 'null'
        financialCompanyExternalId:
          type:
          - string
          - 'null'
        financialSystemBaseUrl:
          type:
          - string
          - 'null'
        clientId:
          type:
          - string
          - 'null'
        clientSecret:
          type:
          - string
          - 'null'
        environment:
          type:
          - string
          - 'null'
      additionalProperties: false
    GetApiUserResponseModelAPIResponse:
      type: object
      properties:
        version:
          type:
          - string
          - 'null'
        statusCode:
          type: integer
          format: int32
        message:
          type:
          - string
          - 'null'
        responseException:
          allOf:
          - $ref: '#/components/schemas/ApiError'
        result:
          allOf:
          - $ref: '#/components/schemas/GetApiUserResponseModel'
      additionalProperties: false
    AuthenticateAPIUser:
      required:
      - password
      - username
      type: object
      properties:
        username:
          minLength: 1
          type: string
        password:
          minLength: 1
          type: string
      additionalProperties: false
   

# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eci-solutions/refs/heads/main/openapi/eci-solutions-api-user-api-openapi.yml