PRIMIS

PRIMIS Auth API

The Auth API from PRIMIS — 6 operation(s) for auth.

GitHub OpenAPI

Operations 6

POST /invitations/register/{token} Register the user (Used for invitations and email verifications) #
POST /auth/login Login the user #
GET /auth/acl Get user's access control lists #
POST /auth/forgot-password Send forgot password email #
POST /auth/reset-password/{token} Reset the user's password #
POST /auth/change-password Change the user's password #

Documentation

📖
APIReference
https://api.primis.cx/api-docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/openapi/primis-auth-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/conventions/primis-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/errors/primis-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/data-model/primis-data-model.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/lifecycle/primis-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/conformance/primis-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/sandbox/primis-sandbox.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/primis/refs/heads/main/apis.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/primis-auth-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

primis-auth-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: REST Auth API
  version: 1.1.0
  description: Primis API docs
servers:
- url: https://api.primis.cx
  description: Production server
- url: https://api.qa.primis.cx
  description: QA Server
tags:
- name: Auth
paths:
  /invitations/register/{token}:
    post:
      tags:
      - Auth
      summary: Register the user (Used for invitations and email verifications)
      parameters:
      - in: path
        name: token
        schema:
          type: string
        required: true
        description: Identifing token of the invite
      requestBody:
        content:
          application/json:
            schema:
              properties:
                password:
                  type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  user:
                    $ref: '#/components/schemas/User'
                  access:
                    $ref: '#/components/schemas/UserFeatureAccess'
                  jwt:
                    type: string
        '500':
          description: Server Error
      operationId: postInvitationsRegisterByToken
      x-operation-id-source: derived
  /auth/login:
    post:
      tags:
      - Auth
      summary: Login the user
      requestBody:
        content:
          application/json:
            schema:
              properties:
                email:
                  type: string
                password:
                  type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  user:
                    $ref: '#/components/schemas/User'
                  access:
                    $ref: '#/components/schemas/UserFeatureAccess'
                  jwt:
                    type: string
        '500':
          description: Server Error
      operationId: postAuthLogin
      x-operation-id-source: derived
  /auth/acl:
    get:
      tags:
      - Auth
      summary: Get user's access control lists
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserFeatureAccess'
        '500':
          description: Server Error
      operationId: getAuthAcl
      x-operation-id-source: derived
  /auth/forgot-password:
    post:
      tags:
      - Auth
      summary: Send forgot password email
      requestBody:
        content:
          application/json:
            schema:
              properties:
                email:
                  type: string
      responses:
        '200':
          description: Ok
        '500':
          description: Server Error
      operationId: postAuthForgotPassword
      x-operation-id-source: derived
  /auth/reset-password/{token}:
    post:
      tags:
      - Auth
      summary: Reset the user's password
      parameters:
      - in: path
        name: token
        schema:
          type: string
        required: true
        description: Reset password token
      requestBody:
        content:
          application/json:
            schema:
              properties:
                password:
                  type: string
      responses:
        '200':
          description: Ok
        '500':
          description: Server Error
      operationId: postAuthResetPasswordByToken
      x-operation-id-source: derived
  /auth/change-password:
    post:
      tags:
      - Auth
      summary: Change the user's password
      requestBody:
        content:
          application/json:
            schema:
              properties:
                currentPassword:
                  type: string
                newPassword:
                  type: string
      responses:
        '200':
          description: Ok
        '500':
          description: Server Error
      operationId: postAuthChangePassword
      x-operation-id-source: derived
components:
  schemas:
    UserFeatureAccess:
      properties:
        subscription:
          type: array
          items:
            $ref: '#/components/schemas/FeaturePermissions'
        role:
          type: array
          items:
            $ref: '#/components/schemas/FeaturePermissions'
      title: UserFeatureAccess
      type: object
    User:
      properties:
        id:
          title: User.id
          type: string
        retailer:
          title: User.retailer
          type: string
        name:
          title: User.name
          type: string
        surname:
          title: User.surname
          type: string
        email:
          title: User.email
          type: string
        role:
          type: string
          enum:
          - retail-admin
          - developer
          - marketing
        blocked:
          title: User.blocked
          type: boolean
      required:
      - email
      additionalProperties: false
      title: User
      type: object
    FeaturePermissions:
      properties:
        feature:
          type: string
        actions:
          items:
            type: string
          title: FeaturePermissions.actions
          type: array
      required:
      - feature
      - actions
      additionalProperties: false
      title: FeaturePermissions
      type: object
  securitySchemes:
    bearerAuth:
      type: https
      scheme: bearer
      bearerFormat: JWT