Payload

Payload Authentication API

The Authentication API from Payload — 8 operation(s) for authentication.

GitHub OpenAPI

Operations 8

POST /api/{userCollection}/login Login and receive a JWT token #
POST /api/{userCollection}/logout Logout current session #
GET /api/{userCollection}/me Get current authenticated user #
POST /api/{userCollection}/refresh-token Refresh the JWT token #
POST /api/{userCollection}/verify/{token} Verify a newly-registered user via email token #
POST /api/{userCollection}/forgot-password Initiate forgot-password flow #
POST /api/{userCollection}/reset-password Reset password using a token #
POST /api/{userCollection}/unlock Unlock a locked user account #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/payload/refs/heads/main/openapi/payload-authentication-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/payload-authentication-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

payload-authentication-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Payload CMS REST Authentication API
  description: Payload is a TypeScript-first headless CMS and application framework that auto-generates REST and GraphQL APIs from collection schemas. The REST API exposes collections at /api/{collection-slug}, globals at /api/globals/{global-slug}, auth operations at /api/{user-collection}/login etc., and user preferences at /api/payload-preferences/{key}. Authentication uses JWT tokens issued by the login endpoint.
  version: '3.0'
  contact:
    name: Payload
    url: https://payloadcms.com/docs
servers:
- url: https://example.com
  description: Self-hosted Payload instance (replace with your deployment).
security:
- bearerAuth: []
tags:
- name: Authentication
paths:
  /api/{userCollection}/login:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
      description: Auth-enabled collection slug (e.g. users).
    post:
      tags:
      - Authentication
      summary: Login and receive a JWT token
      operationId: login
      responses:
        '200':
          description: JWT token and user object.
  /api/{userCollection}/logout:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication
      summary: Logout current session
      operationId: logout
      responses:
        '200':
          description: Logged out.
  /api/{userCollection}/me:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Authentication
      summary: Get current authenticated user
      operationId: me
      responses:
        '200':
          description: Current user.
  /api/{userCollection}/refresh-token:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication
      summary: Refresh the JWT token
      operationId: refreshToken
      responses:
        '200':
          description: New JWT issued.
  /api/{userCollection}/verify/{token}:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
    - name: token
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication
      summary: Verify a newly-registered user via email token
      operationId: verifyUser
      responses:
        '200':
          description: User verified.
  /api/{userCollection}/forgot-password:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication
      summary: Initiate forgot-password flow
      operationId: forgotPassword
      responses:
        '200':
          description: Email sent.
  /api/{userCollection}/reset-password:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication
      summary: Reset password using a token
      operationId: resetPassword
      responses:
        '200':
          description: Password reset.
  /api/{userCollection}/unlock:
    parameters:
    - name: userCollection
      in: path
      required: true
      schema:
        type: string
    post:
      tags:
      - Authentication
      summary: Unlock a locked user account
      operationId: unlockUser
      responses:
        '200':
          description: User unlocked.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JWT issued by the login endpoint. Send as `Authorization: JWT <token>` or via cookie.'