Scalar

Scalar Login Portals API

The login-portals API from Scalar — 3 operation(s) for login-portals.

GitHub OpenAPI

Operations 5

GET /login-portals/{slug} Getlogin portals slug #
GET /login-portals Getlogin portals #
POST /login-portals Postlogin portals #
DELETE /login-portals Deletelogin portals #
POST /login-portals/update Postlogin portals update #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/openapi/scalar-login-portals-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-login-portal-page-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-login-portal-email-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-login-portal-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-slug-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/scalar/refs/heads/main/json-schema/scalar-nanoid-schema.json

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/scalar-login-portals-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

scalar-login-portals-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Scalar Login Portals API
  contact:
    name: Marc from Scalar
    url: https://scalar.com
    email: support@scalar.com
  version: '1.0'
  description: 'Operations tagged login-portals across 2 of this provider''s published API definitions: scalar-core.json, scalar-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.scalar.com/core
security:
- BearerAuth: []
tags:
- name: login-portals
paths:
  /login-portals/{slug}:
    get:
      tags:
      - login-portals
      description: Get a login portal
      operationId: getloginPortalsSlug
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/login-portal'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      parameters:
      - schema:
          type: string
        in: path
        name: slug
        required: true
      summary: Getlogin portals slug
      x-summary-source: derived
  /login-portals:
    get:
      tags:
      - login-portals
      description: Get a list of all login portals for the team
      operationId: getloginPortals
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    uid:
                      $ref: '#/components/schemas/nanoid'
                    title:
                      type: string
                      maxLength: 200
                    slug:
                      $ref: '#/components/schemas/slug'
                  required:
                  - uid
                  - title
                  - slug
                  additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      summary: Getlogin portals
      x-summary-source: derived
    post:
      tags:
      - login-portals
      description: Create a new login portal for the team
      operationId: postloginPortals
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  uid:
                    type: string
                required:
                - uid
                additionalProperties: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                slug:
                  type: string
                email:
                  $ref: '#/components/schemas/login-portal-email'
                page:
                  $ref: '#/components/schemas/login-portal-page'
              required:
              - title
              - slug
              - email
              - page
              additionalProperties: false
        required: true
      summary: Postlogin portals
      x-summary-source: derived
    delete:
      tags:
      - login-portals
      description: Delete a specific login portal
      operationId: deleteloginPortals
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                slug:
                  type: string
              required:
              - slug
              additionalProperties: false
        required: true
      summary: Deletelogin portals
      x-summary-source: derived
  /login-portals/update:
    post:
      tags:
      - login-portals
      description: Update login portals metadata
      operationId: postloginPortalsUpdate
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: 'null'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/400'
        '401':
          description: No auth
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404'
        '422':
          description: Invalid payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/422'
        '500':
          description: Uncaught error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/500'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                slug:
                  type: string
                title:
                  type: string
              required:
              - slug
              additionalProperties: false
        required: true
      summary: Postlogin portals update
      x-summary-source: derived
components:
  schemas:
    login-portal-email:
      type: object
      properties:
        logo:
          default: ''
          type: string
        logoSize:
          default: '100'
          type: string
        buttonText:
          default: Login
          type: string
          maxLength: 50
        message:
          default: Click to access private documentation hosted by scalar.com
          type: string
          maxLength: 1000
        title:
          default: Private Docs
          type: string
          maxLength: 100
        mainColor:
          default: '#2a2f45'
          type: string
          maxLength: 100
        mainBackground:
          default: '#f6f6f6'
          type: string
          maxLength: 100
        cardColor:
          default: 2a2f45
          type: string
          maxLength: 100
        cardBackground:
          default: '#fff'
          type: string
          maxLength: 100
        buttonColor:
          default: '#fff'
          type: string
          maxLength: 100
        buttonBackground:
          default: '#0f0f0f'
          type: string
          maxLength: 100
      required:
      - logo
      - logoSize
      - buttonText
      - message
      - title
      - mainColor
      - mainBackground
      - cardColor
      - cardBackground
      - buttonColor
      - buttonBackground
      additionalProperties: false
    nanoid:
      type: string
      minLength: 5
    '404':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    slug:
      type: string
      minLength: 3
      maxLength: 60
      pattern: ^[a-z](?:[a-z0-9-]*[a-z0-9])?$
    '403':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    login-portal:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid'
        title:
          type: string
          maxLength: 200
        slug:
          $ref: '#/components/schemas/slug'
        email:
          $ref: '#/components/schemas/login-portal-email'
        page:
          $ref: '#/components/schemas/login-portal-page'
      required:
      - uid
      - title
      - slug
      - email
      - page
      additionalProperties: false
    '422':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    '400':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    '401':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    login-portal-page:
      type: object
      properties:
        title:
          default: Scalar Private Docs
          type: string
          maxLength: 100
        description:
          default: Login to access your documentation
          type: string
          maxLength: 500
        head:
          default: ''
          type: string
        script:
          default: ''
          type: string
        theme:
          default: ''
          type: string
        companyName:
          default: ''
          type: string
          maxLength: 100
        logo:
          default: ''
          type: string
        logoURL:
          default: ''
          type: string
        favicon:
          default: ''
          type: string
        termsLink:
          default: ''
          type: string
        privacyLink:
          default: ''
          type: string
        formTitle:
          default: Scalar Private Docs
          type: string
          maxLength: 100
        formDescription:
          default: Login to access your documentation
          type: string
          maxLength: 500
        formImage:
          default: ''
          type: string
      required:
      - title
      - description
      - head
      - script
      - theme
      - companyName
      - logo
      - logoURL
      - favicon
      - termsLink
      - privacyLink
      - formTitle
      - formDescription
      - formImage
      additionalProperties: false
    '500':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    login-portal-email_2:
      type: object
      properties:
        logo:
          default: ''
          examples:
          - <img src="https://example.com/logo.svg" alt="Acme" />
          type: string
        logoSize:
          default: '100'
          examples:
          - '100'
          type: string
        buttonText:
          default: Login
          examples:
          - Access documentation
          type: string
          maxLength: 50
        message:
          default: Click to access private documentation hosted by scalar.com
          examples:
          - Click to access Acme private API documentation.
          type: string
          maxLength: 1000
        title:
          default: Private Docs
          examples:
          - Acme API
          type: string
          maxLength: 100
        mainColor:
          default: '#2a2f45'
          examples:
          - '#1f2937'
          type: string
          maxLength: 100
        mainBackground:
          default: '#f6f6f6'
          examples:
          - '#f9fafb'
          type: string
          maxLength: 100
        cardColor:
          default: '#2a2f45'
          examples:
          - '#1f2937'
          type: string
          maxLength: 100
        cardBackground:
          default: '#fff'
          examples:
          - '#ffffff'
          type: string
          maxLength: 100
        buttonColor:
          default: '#fff'
          examples:
          - '#ffffff'
          type: string
          maxLength: 100
        buttonBackground:
          default: '#0f0f0f'
          examples:
          - '#2563eb'
          type: string
          maxLength: 100
      required:
      - logo
      - logoSize
      - buttonText
      - message
      - title
      - mainColor
      - mainBackground
      - cardColor
      - cardBackground
      - buttonColor
      - buttonBackground
      additionalProperties: false
    nanoid_2:
      type: string
      minLength: 5
      examples:
      - UakgbKJ5m9gl0JDMbcJqL
    '404_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Resource not found.
        code: not-found
    slug_2:
      type: string
      minLength: 1
      maxLength: 60
      pattern: ^[a-z](?:[a-z0-9-]*[a-z0-9])?$
      examples:
      - acme-api
    '403_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: You do not have permission to access this resource.
        code: forbidden
    login-portal_2:
      type: object
      properties:
        uid:
          $ref: '#/components/schemas/nanoid_2'
        title:
          type: string
          maxLength: 200
          examples:
          - Acme API
        slug:
          $ref: '#/components/schemas/slug_2'
        email:
          $ref: '#/components/schemas/login-portal-email_2'
        page:
          $ref: '#/components/schemas/login-portal-page_2'
      required:
      - uid
      - title
      - slug
      - email
      - page
      additionalProperties: false
    '422_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: The request body contains invalid values.
        code: invalid-payload
    '400_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Invalid request parameters.
        code: bad-request
    '401_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: Invalid authentication token.
        code: unauthorized
    login-portal-page_2:
      type: object
      properties:
        title:
          default: Scalar Private Docs
          examples:
          - Acme API
          type: string
          maxLength: 100
        description:
          default: Login to access your documentation
          examples:
          - Sign in with your work email to access Acme documentation.
          type: string
          maxLength: 500
        head:
          default: ''
          examples:
          - <meta name="robots" content="noindex" />
          type: string
        script:
          default: ''
          examples:
          - document.documentElement.dataset.company = "acme";
          type: string
        theme:
          default: ''
          examples:
          - TakgbKJ5m9gl0JDMbcJqL
          type: string
        companyName:
          default: ''
          examples:
          - Acme
          type: string
          maxLength: 100
        logo:
          default: ''
          examples:
          - <img src="https://example.com/logo.svg" alt="Acme" />
          type: string
        logoURL:
          default: ''
          examples:
          - https://example.com
          type: string
        favicon:
          default: ''
          examples:
          - https://example.com/favicon.ico
          type: string
        termsLink:
          default: ''
          examples:
          - https://example.com/terms
          type: string
        privacyLink:
          default: ''
          examples:
          - https://example.com/privacy
          type: string
        formTitle:
          default: Scalar Private Docs
          examples:
          - Sign in to Acme Documentation
          type: string
          maxLength: 100
        formDescription:
          default: Login to access your documentation
          examples:
          - Sign in with your work email to access Acme documentation.
          type: string
          maxLength: 500
        formImage:
          default: ''
          examples:
          - https://example.com/login-banner.png
          type: string
      required:
      - title
      - description
      - head
      - script
      - theme
      - companyName
      - logo
      - logoURL
      - favicon
      - termsLink
      - privacyLink
      - formTitle
      - formDescription
      - formImage
      additionalProperties: false
    '500_2':
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
      examples:
      - message: An unexpected error occurred.
        code: unknown
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- scalar-core.json
- scalar-openapi.json