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

Nhost session API

Session management operations including token refresh, verification, and sign-out

Nhost session API is one of 14 APIs that Nhost publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include session. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://{subdomain}.auth.{region}.nhost.run/v1.

3 operations 3 paths 7 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://{subdomain}.nhost.run/v1/graphql
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nhost session API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). It accepts HTTP bearer tokens (BearerAuthElevated).

  • BearerAuth — Bearer authentication with JWT access token. Used to authenticate requests to protected endpoints.
  • BearerAuthElevated — Bearer authentication that requires elevated permissions. Used for sensitive operations that may require additional security measures such as recent authentica…

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.

session 3

Session management operations including token refresh, verification, and sign-out

POST
/signout
Sign out
signOut body → 200default
POST
/token
Refresh access token
refreshToken body → 200default
POST
/token/verify
Verify JWT token
verifyToken body → 200default

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), Session (5 properties), ErrorResponse (3 properties), SignOutRequest (2 properties). Each schema is shown below with its type and property counts.

User
object
User profile and account information
14 properties 11 required
SignOutRequest
object
2 properties
ErrorResponse
object
Standardized error response
3 properties 3 required
Session
object
User authentication session containing tokens and user information
5 properties 4 required
OKResponse
string
RefreshTokenRequest
object
Request to refresh an access token
1 property 1 required
VerifyTokenRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhost-session-api-openapi.yml Raw ↑

Other APIs Nhost publishes across the network.

Nhost GraphQL API
Nhost Serverless Functions API
Nhost AI API
Nhost authentication API
Nhost documentation API
Nhost excludeme API
Nhost files API
Nhost operations API
Nhost security API
Nhost storage API
Nhost system API
Nhost user API