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-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 Auth API
  version: 5.4.0
tags:
- name: Auth
paths:
  /api/login:
    post:
      tags:
      - Auth
      summary: Login
      description: 'Session login endpoint


        Args:

        request (Request): Fastapi Request object

        credentials: Defaults to Depends(HTTPBasic()).


        Raises:

        CredentialsException: Invalid credentials

        UserDisabledException: Auth is disabled'
      operationId: login_api_login_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBasic: []
  /api/logout:
    post:
      tags:
      - Auth
      summary: Logout
      description: 'Session logout endpoint


        Args:

        request (Request): Fastapi Request object


        Returns:

        Optional[dict]: When OIDC RP-Initiated Logout is enabled and the session

        contains an OIDC id_token, returns a dict with the OIDC end-session URL

        so the client can redirect the browser to log out of the OIDC provider.'
      operationId: logout_api_logout_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/OIDCLogoutResponse'
                - type: 'null'
                title: Response Logout Api Logout Post
  /api/token:
    post:
      tags:
      - Auth
      summary: Token
      description: 'OAuth2 token endpoint


        Args:

        form_data (Annotated[OAuth2RequestForm, Depends): Form Data with OAuth2 info


        Raises:

        HTTPException: Missing refresh token

        HTTPException: Invalid refresh token

        HTTPException: Missing username or password

        HTTPException: Invalid username or password

        HTTPException: Client credentials are not yet supported

        HTTPException: Invalid or unsupported grant type

        HTTPException: Insufficient scope


        Returns:

        TokenResponse: TypedDict with the new generated token info'
      operationId: token_api_token_post
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_token_api_token_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/login/openid:
    get:
      tags:
      - Auth
      summary: Login Via Openid
      description: 'OIDC login endpoint


        Args:

        request (Request): Fastapi Request object


        Raises:

        OIDCDisabledException: OAuth is disabled

        OIDCNotConfiguredException: OAuth not configured


        Returns:

        RedirectResponse: Redirect to OIDC provider'
      operationId: login_via_openid_api_login_openid_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/oauth/openid:
    get:
      tags:
      - Auth
      summary: Auth Openid
      description: 'OIDC callback endpoint


        Args:

        request (Request): Fastapi Request object


        Raises:

        OIDCDisabledException: OAuth is disabled

        OIDCNotConfiguredException: OAuth not configured

        AuthCredentialsException: Invalid credentials

        UserDisabledException: Auth is disabled


        Returns:

        RedirectResponse: Redirect to home, or to login if the provider rejects'
      operationId: auth_openid_api_oauth_openid_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/forgot-password:
    post:
      tags:
      - Auth
      summary: Request Password Reset
      description: 'Request a password reset link for the user.


        Args:

        username (str): Username of the user requesting the reset

        Returns:

        None: Returns 200 OK status'
      operationId: request_password_reset_api_forgot_password_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Body_request_password_reset_api_forgot_password_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/reset-password:
    post:
      tags:
      - Auth
      summary: Reset Password
      description: 'Reset password using the token.


        Args:

        token (str): Reset token from the URL

        new_password (str): New user password


        Returns:

        None: Returns 200 OK status'
      operationId: reset_password_api_reset_password_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Body_reset_password_api_reset_password_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TokenResponse:
      properties:
        access_token:
          type: string
          title: Access Token
        token_type:
          type: string
          title: Token Type
        expires:
          type: integer
          title: Expires
        refresh_token:
          type: string
          title: Refresh Token
        refresh_expires:
          type: integer
          title: Refresh Expires
      type: object
      required:
      - access_token
      - token_type
      - expires
      title: TokenResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_reset_password_api_reset_password_post:
      properties:
        token:
          type: string
          title: Token
        new_password:
          type: string
          title: New Password
      type: object
      required:
      - token
      - new_password
      title: Body_reset_password_api_reset_password_post
    Body_request_password_reset_api_forgot_password_post:
      properties:
        username:
          type: string
          title: Username
      type: object
      required:
      - username
      title: Body_request_password_reset_api_forgot_password_post
    OIDCLogoutResponse:
      properties:
        oidc_logout_url:
          type: string
          title: Oidc Logout Url
      type: object
      required:
      - oidc_logout_url
      title: OIDCLogoutResponse
    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
    Body_token_api_token_post:
      properties:
        grant_type:
          type: string
          title: Grant Type
          default: password
        scope:
          type: string
          title: Scope
          default: ''
        username:
          anyOf:
          - type: string
          - type: 'null'
          title: Username
        password:
          anyOf:
          - type: string
          - type: 'null'
          title: Password
        client_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Id
        client_secret:
          anyOf:
          - type: string
          - type: 'null'
          title: Client Secret
        refresh_token:
          anyOf:
          - type: string
          - type: 'null'
          title: Refresh Token
      type: object
      title: Body_token_api_token_post
  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