SignOps

SignOps Authenticator API

The Authenticator API from SignOps — 6 operation(s) for authenticator.

GitHub OpenAPI

Operations 8

POST /v1/totp/enroll Start authenticator enrolment #
POST /v1/totp/confirm Confirm with the first code #
POST /v1/totp/verify Check a code #
POST /v1/totp/backup-codes New backup codes #
GET /v1/users/{user_id}/totp Authenticator status #
DELETE /v1/users/{user_id}/totp Remove the authenticator #
GET /v1/users/{user_id}/lock Lock status #
DELETE /v1/users/{user_id}/lock Unlock the user #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/signops/openapi/signops-authenticator-api-openapi.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/signops:signops-authenticator-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

signops-authenticator-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SignOps Authenticator API
  version: 1.0.0
  description: 'Push notifications to Android, iOS and the web, login approval on a trusted phone, passkeys, authenticator codes and email OTP, on one API key and your own user ids. Errors are { error: { code, message } }. Test keys (sk_test_) send only to test devices and addresses and are not billed.'
  contact:
    email: hello@signops.dev
    url: https://signops.dev/docs/
  termsOfService: https://signops.dev/terms/
servers:
- url: https://api.signops.dev
security:
- secretKey: []
tags:
- name: Authenticator
paths:
  /v1/totp/enroll:
    post:
      operationId: postTotpEnroll
      summary: Start authenticator enrolment
      description: Returns the key, an otpauth link and a QR code as SVG for your page. Not kept for idempotency or logs.
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: The same key within 24 hours returns the first result instead of acting twice.
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: string
                  description: Your own id for the user, up to 128 characters without spaces.
                  maxLength: 128
                label:
                  type: string
                  description: Shown in the authenticator app, like the user's email.
                issuer:
                  type: string
                  description: Your app's name in the authenticator app.
              required:
              - user_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    description: Your own id for the user, up to 128 characters without spaces.
                    maxLength: 128
                  status:
                    type: string
                    description: pending
                  secret:
                    type: string
                    description: Base32 key.
                  otpauth_uri:
                    type: string
                    description: otpauth:// link.
                  qr_svg:
                    type: string
                    description: QR code as SVG.
                  digits:
                    type: integer
                    description: '6'
                  period:
                    type: integer
                    description: '30'
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/totp/confirm:
    post:
      operationId: postTotpConfirm
      summary: Confirm with the first code
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: The same key within 24 hours returns the first result instead of acting twice.
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: string
                  description: Your own id for the user, up to 128 characters without spaces.
                  maxLength: 128
                code:
                  type: string
                  description: 6-digit code from the app.
              required:
              - user_id
              - code
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    description: Your own id for the user, up to 128 characters without spaces.
                    maxLength: 128
                  status:
                    type: string
                    description: confirmed
                  backup_codes:
                    type: array
                    items:
                      type: string
                      description: Backup code.
                    description: 10 backup codes, shown once.
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/totp/verify:
    post:
      operationId: postTotpVerify
      summary: Check a code
      description: An app code or a backup code. Five wrong codes in 15 minutes lock the user (429 user_locked).
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: The same key within 24 hours returns the first result instead of acting twice.
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: string
                  description: Your own id for the user, up to 128 characters without spaces.
                  maxLength: 128
                code:
                  type: string
                  description: App code or backup code.
              required:
              - user_id
              - code
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  valid:
                    type: boolean
                    description: Whether the code was right.
                  user_id:
                    type: string
                    description: Your own id for the user, up to 128 characters without spaces.
                    maxLength: 128
                  method:
                    type: string
                    description: totp or backup_code, null when wrong.
                  backup_codes_left:
                    type: integer
                    description: Backup codes left.
                  failures_before_lock:
                    type: integer
                    description: 'When wrong: tries left before the lock.'
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/totp/backup-codes:
    post:
      operationId: postTotpBackupCodes
      summary: New backup codes
      description: The old codes stop working.
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: The same key within 24 hours returns the first result instead of acting twice.
        schema:
          type: string
          maxLength: 128
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: string
                  description: Your own id for the user, up to 128 characters without spaces.
                  maxLength: 128
              required:
              - user_id
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    description: Your own id for the user, up to 128 characters without spaces.
                    maxLength: 128
                  backup_codes:
                    type: array
                    items:
                      type: string
                      description: Backup code.
                    description: 10 new codes.
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/users/{user_id}/totp:
    get:
      operationId: getUsersByUserIdTotp
      summary: Authenticator status
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteUsersByUserIdTotp
      summary: Remove the authenticator
      description: For a lost phone.
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    description: Your own id for the user, up to 128 characters without spaces.
                    maxLength: 128
                  removed:
                    type: boolean
                    description: 'true'
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/users/{user_id}/lock:
    get:
      operationId: getUsersByUserIdLock
      summary: Lock status
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    description: Your own id for the user, up to 128 characters without spaces.
                    maxLength: 128
                  locked:
                    type: boolean
                    description: Whether the user is locked.
                  locked_until:
                    type: string
                    description: ISO 8601 time.
                    format: date-time
                  failures:
                    type: integer
                    description: Wrong codes in the current window.
                  failures_before_lock:
                    type: integer
                    description: '5'
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteUsersByUserIdLock
      summary: Unlock the user
      tags:
      - Authenticator
      security:
      - secretKey: []
      parameters:
      - name: user_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    description: Your own id for the user, up to 128 characters without spaces.
                    maxLength: 128
                  locked:
                    type: boolean
                    description: 'false'
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable code, like invalid_request, rate_limited or expired.
            message:
              type: string
              description: Written for a developer to read.
          required:
          - code
          - message
      required:
      - error
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: sk_live_... or sk_test_..., on your server only.
    publishableKey:
      type: http
      scheme: bearer
      description: pk_live_... or pk_test_..., used by the SDKs in apps and browsers.
externalDocs:
  description: Docs
  url: https://signops.dev/docs/