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/romm:romm-device-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

openapi: 3.2.0
info:
  title: RomM Device Auth API
  version: 5.4.0
tags:
- name: device-auth
paths:
  /api/auth/device/init:
    post:
      tags:
      - device-auth
      summary: Device Auth Init
      description: 'Device-initiated: start a new pairing flow. Open endpoint, rate-limited.'
      operationId: device_auth_init_api_auth_device_init_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceAuthInitPayload'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceAuthInitResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/auth/device/pending/{user_code}:
    get:
      tags:
      - device-auth
      summary: Get Pending
      description: Fetch a pending request's metadata for the approval screen.
      operationId: get_pending_api_auth_device_pending__user_code__get
      security:
      - OAuth2PasswordBearer:
        - me.read
      - HTTPBasic: []
      parameters:
      - name: user_code
        in: path
        required: true
        schema:
          type: string
          title: User Code
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceAuthPendingSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/auth/device/approve:
    post:
      tags:
      - device-auth
      summary: Approve
      description: Create the Device + bound ClientToken and mark the request approved.
      operationId: approve_api_auth_device_approve_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceAuthApprovePayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceAuthApproveResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
  /api/auth/device/deny:
    post:
      tags:
      - device-auth
      summary: Deny
      operationId: deny_api_auth_device_deny_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceAuthDenyPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2PasswordBearer:
        - me.write
      - HTTPBasic: []
  /api/auth/device/token:
    post:
      tags:
      - device-auth
      summary: Token
      description: Device-facing polling endpoint. Open, rate-limited per-IP and per-code.
      operationId: token_api_auth_device_token_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceAuthTokenPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceAuthTokenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    DeviceAuthApproveResponse:
      properties:
        device_id:
          type: string
          title: Device Id
        device_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Device Name
      type: object
      required:
      - device_id
      - device_name
      title: DeviceAuthApproveResponse
    DeviceAuthTokenPayload:
      properties:
        device_code:
          type: string
          maxLength: 128
          minLength: 1
          title: Device Code
      type: object
      required:
      - device_code
      title: DeviceAuthTokenPayload
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DeviceAuthInitResponse:
      properties:
        device_code:
          type: string
          title: Device Code
        user_code:
          type: string
          title: User Code
        verification_path:
          type: string
          title: Verification Path
          description: Relative web-UI path (/pair/device). The client joins it with the origin it was configured to reach; the server is origin-agnostic.
        verification_path_complete:
          type: string
          title: Verification Path Complete
          description: Same path with ?user_code= appended, for QR display.
        expires_in:
          type: integer
          title: Expires In
        interval:
          type: integer
          title: Interval
      type: object
      required:
      - device_code
      - user_code
      - verification_path
      - verification_path_complete
      - expires_in
      - interval
      title: DeviceAuthInitResponse
    DeviceAuthDenyPayload:
      properties:
        user_code:
          type: string
          maxLength: 32
          minLength: 1
          title: User Code
      type: object
      required:
      - user_code
      title: DeviceAuthDenyPayload
    DeviceAuthInitPayload:
      properties:
        client_device_identifier:
          type: string
          maxLength: 255
          minLength: 1
          title: Client Device Identifier
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
        client:
          type: string
          maxLength: 50
          minLength: 1
          title: Client
        platform:
          anyOf:
          - type: string
            maxLength: 50
          - type: 'null'
          title: Platform
        client_version:
          anyOf:
          - type: string
            maxLength: 50
          - type: 'null'
          title: Client Version
        requested_scopes:
          items:
            type: string
          type: array
          maxItems: 22
          minItems: 1
          title: Requested Scopes
      type: object
      required:
      - client_device_identifier
      - name
      - client
      - requested_scopes
      title: DeviceAuthInitPayload
    DeviceAuthTokenResponse:
      properties:
        access_token:
          type: string
          title: Access Token
        device_id:
          type: string
          title: Device Id
        scopes:
          items:
            type: string
          type: array
          title: Scopes
        expires_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires At
      type: object
      required:
      - access_token
      - device_id
      - scopes
      - expires_at
      title: DeviceAuthTokenResponse
    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
    DeviceAuthApprovePayload:
      properties:
        user_code:
          type: string
          maxLength: 32
          minLength: 1
          title: User Code
        approved_scopes:
          items:
            type: string
          type: array
          minItems: 1
          title: Approved Scopes
        device_name:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Device Name
        expires_in:
          anyOf:
          - type: string
          - type: 'null'
          title: Expires In
      type: object
      required:
      - user_code
      - approved_scopes
      title: DeviceAuthApprovePayload
    DeviceAuthPendingSchema:
      properties:
        client_device_identifier:
          type: string
          title: Client Device Identifier
        name:
          type: string
          title: Name
        client:
          type: string
          title: Client
        platform:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
        client_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Version
        requested_scopes:
          items:
            type: string
          type: array
          title: Requested Scopes
        allowed_scopes:
          items:
            type: string
          type: array
          title: Allowed Scopes
        expires_at:
          type: string
          title: Expires At
      type: object
      required:
      - client_device_identifier
      - name
      - client
      - platform
      - client_version
      - requested_scopes
      - allowed_scopes
      - expires_at
      title: DeviceAuthPendingSchema
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            me.read: View your profile
            roms.read: View ROMs
            platforms.read: View platforms
            assets.read: View assets
            devices.read: View devices
            firmware.read: View firmware
            roms.user.read: View user-rom properties
            collections.read: View collections
            playlists.read: View music playlists
            me.write: Modify your profile
            assets.write: Modify assets
            devices.write: Modify devices
            roms.user.write: Modify user-rom properties
            collections.write: Modify collections
            playlists.write: Modify music playlists
            roms.write: Modify ROMs
            platforms.write: Modify platforms
            firmware.write: Modify firmware
            users.read: View users
            users.write: Modify users
            tasks.run: Run tasks
            logs.read: View backend logs
          tokenUrl: /token
    HTTPBasic:
      type: http
      scheme: basic