Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ReqRes Authentication API

The Authentication API from ReqRes — 3 operation(s) for authentication.

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

This API exposes 16 JSON Schema definitions.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, an engineering blog, a JSON-LD context, and 16 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.1.0.

Requests are made against 2 base URLs: https://reqres.in, http://localhost:8000.

3 operations 3 paths 4 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.1.0
Base URL
https://reqres.in/
Authentication
API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

ReqRes Authentication API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It accepts HTTP bearer tokens (session_token) (BearerAuth).

Paths & Operations 3

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

Authentication 3
POST
/api/register
ReqRes Register User
registerUser body → 200400
POST
/api/login
ReqRes Login User
loginUser body → 200400
POST
/api/logout
ReqRes Logout User
logoutUser → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (2 properties), RegisterResponse (2 properties), AuthRequest (2 properties), LoginResponse (1 property). Each schema is shown below with its type and property counts.

LoginResponse
object
1 property 1 required
AuthRequest
object
2 properties 2 required
RegisterResponse
object
2 properties 1 required
ErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reqres-authentication-api-openapi.yml Raw ↑

Other APIs ReqRes publishes across the network.

ReqRes Agent Sandbox API
ReqRes App Users API
ReqRes Collections API
ReqRes Custom Endpoints API
ReqRes Legacy API