SoilOptix Authentication API

Follows the OAuth 2.0 Specification and adds additional forgot password functionality. New users can only be registered with a valid business invitation key. (**Tip:** Create a new Business Invite to have a key sent to a new user).

Operations 6

POST /api/v4/auth/token Login Direct Flow #
POST /api/v4/auth/refresh Refresh #
POST /api/v4/auth/resetPassword Reset Password #
GET /api/v4/auth/forgotPassword Forgot Password #
POST /api/v4/auth/resetForgottenPassword Reset Forgotten Password #
POST /api/v4/auth/registerUser Register User #

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/soiloptix:soiloptix-authentication-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.

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

OpenAPI Specification

soiloptix-authentication-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: SoilOptix Client Authentication API
  version: '1.0'
  description: Service to retrieve data from SoilOptix Db for Clients portal
  termsOfService: https://soiloptix.com/terms-of-service/
  contact:
    name: Get Help with this API
    url: http://www.soiloptix.com
    email: dev@soiloptix.com
    copyright: SoilOptix 2022-2025
tags:
- name: Authentication
  description: Follows the OAuth 2.0 Specification and adds additional forgot password functionality. New users can only be registered with a valid business invitation key. (**Tip:** Create a new Business Invite to have a key sent to a new user).
paths:
  /api/v4/auth/token:
    post:
      tags:
      - Authentication
      summary: Login Direct Flow
      operationId: login_direct_flow_api_v4_auth_token_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginSuccess'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/auth/refresh:
    post:
      tags:
      - Authentication
      summary: Refresh
      operationId: refresh_api_v4_auth_refresh_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginSuccess'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/auth/resetPassword:
    post:
      tags:
      - Authentication
      summary: Reset Password
      operationId: reset_password_api_v4_auth_resetPassword_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - Authorization: []
  /api/v4/auth/forgotPassword:
    get:
      tags:
      - Authentication
      summary: Forgot Password
      operationId: forgot_password_api_v4_auth_forgotPassword_get
      parameters:
      - name: email
        in: query
        required: true
        schema:
          type: string
          title: Email
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/auth/resetForgottenPassword:
    post:
      tags:
      - Authentication
      summary: Reset Forgotten Password
      operationId: reset_forgotten_password_api_v4_auth_resetForgottenPassword_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetForgottenPasswordRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v4/auth/registerUser:
    post:
      tags:
      - Authentication
      summary: Register User
      operationId: register_user_api_v4_auth_registerUser_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterUserRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginSuccess'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ResetRequest:
      properties:
        password:
          type: string
          format: password
          title: Password
          writeOnly: true
        new_password:
          type: string
          format: password
          title: New Password
          writeOnly: true
      type: object
      required:
      - password
      - new_password
      title: ResetRequest
      description: Represents a request body that contains current and new password
    LoginSuccess:
      properties:
        access_token:
          type: string
          title: Access Token
        refresh_token:
          type: string
          title: Refresh Token
        token_type:
          type: string
          title: Token Type
        expires_in:
          type: integer
          title: Expires In
      type: object
      required:
      - access_token
      - refresh_token
      - token_type
      - expires_in
      title: LoginSuccess
    RegisterUserRequest:
      properties:
        email:
          type: string
          title: Email
        new_password:
          type: string
          format: password
          title: New Password
          writeOnly: true
        invite_key:
          type: string
          title: Invite Key
      type: object
      required:
      - email
      - new_password
      - invite_key
      title: RegisterUserRequest
    RefreshRequest:
      properties:
        refresh_token:
          type: string
          title: Refresh Token
      type: object
      required:
      - refresh_token
      title: RefreshRequest
      description: 'Represents a request body that contains refresh token

        (camelCase required for v3 compatibilty)'
    ResetForgottenPasswordRequest:
      properties:
        email:
          type: string
          title: Email
        new_password:
          type: string
          format: password
          title: New Password
          writeOnly: true
        reset_key:
          type: string
          title: Reset Key
      type: object
      required:
      - email
      - new_password
      - reset_key
      title: ResetForgottenPasswordRequest
      description: Represents a request body that contains email, new password and reset key for verification
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    LoginRequest:
      properties:
        email:
          type: string
          title: Email
        password:
          type: string
          format: password
          title: Password
          writeOnly: true
      type: object
      required:
      - email
      - password
      title: LoginRequest
      description: Represents a request body that contains email and password
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer