How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Payload Authentication API

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

Payload Authentication API is one of 5 APIs that Payload publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 8 paths. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://example.com.

8 operations 8 paths 0 schemas 1 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
https://payloadcms.com/api
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Payload Authentication API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT issued by the login endpoint. Send as Authorization: JWT or via cookie.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 1 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 8
POST
/api/{userCollection}/login
Login and receive a JWT token
login 1 param → 200
POST
/api/{userCollection}/logout
Logout current session
logout 1 param → 200
GET
/api/{userCollection}/me
Get current authenticated user
me 1 param → 200
POST
/api/{userCollection}/refresh-token
Refresh the JWT token
refreshToken 1 param → 200
POST
/api/{userCollection}/verify/{token}
Verify a newly-registered user via email token
verifyUser 2 params → 200
POST
/api/{userCollection}/forgot-password
Initiate forgot-password flow
forgotPassword 1 param → 200
POST
/api/{userCollection}/reset-password
Reset password using a token
resetPassword 1 param → 200
POST
/api/{userCollection}/unlock
Unlock a locked user account
unlockUser 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payload-authentication-api-openapi.yml Raw ↑

Other APIs Payload publishes across the network.

Payload Collections API
Payload Globals API
Payload Preferences API
Where this information came from

This is an independent, third-party profile of Payload Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.