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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Nhost

Nhost security API

Security-related operations including Personal Access Tokens, WebAuthn management, account elevation, and account linking

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

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

7 operations 7 paths 36 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{subdomain}.nhost.run/v1/graphql
Authentication
HTTP Bearer, HTTP Bearer
Contact
Nhost Support
License
MIT License
Resource Areas
1

Authentication & Security 2

Nhost security 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 7

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

security 7

Security-related operations including Personal Access Tokens, WebAuthn management, account elevation, and account linking

POST
/elevate/webauthn
Elevate access for an already signed in user using FIDO2 Webauthn
elevateWebauthn → 200default
POST
/elevate/webauthn/verify
Verify FIDO2 Webauthn authentication using public-key cryptography for elevation
verifyElevateWebauthn body → 200default
POST
/link/idtoken
Link a user account with the provider's account using an id token
linkIdToken body → 200default
POST
/pat
Create a Personal Access Token (PAT)
createPAT body → 200default
POST
/user/mfa
Manage multi-factor authentication
verifyChangeUserMfa body → 200default
POST
/user/webauthn/add
Initialize adding of a new webauthn security key
addSecurityKey → 200default
POST
/user/webauthn/verify
Verify adding of a new webauthn security key
verifyAddSecurityKey body → 200default

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are User (14 properties), PublicKeyCredentialCreationOptions (11 properties), PublicKeyCredentialRequestOptions (7 properties), AuthenticatorAttestationResponse (6 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Standardized error response
3 properties 3 required
CredentialPropertiesOutput
object
Credential properties extension output
1 property
CredentialParameter
object
2 properties 2 required
CreatePATResponse
object
2 properties 2 required
PublicKeyCredentialRequestOptions
object
7 properties 1 required
AuthenticatorAttachment
string
The authenticator attachment modality
AttestationFormat
string
The attestation statement format
IdTokenProvider
string
AuthenticatorAttestationResponse
object
6 properties 2 required
UserVerificationRequirement
string
A requirement for user verification for the operation
AuthenticatorSelection
object
4 properties
ResidentKeyRequirement
string
The resident key requirement
CreatePATRequest
object
2 properties 1 required
PublicKeyCredentialCreationOptions
object
11 properties 4 required
VerifyAddSecurityKeyRequest
object
2 properties 1 required
CredentialCreationResponse
object
6 properties 4 required
CredentialAssertionResponse
object
6 properties 4 required
PublicKeyCredentialDescriptor
object
3 properties 2 required
AuthenticatorTransport
string
The authenticator transports that can be used
Session
object
User authentication session containing tokens and user information
5 properties 4 required
CredentialType
string
The valid credential types
AuthenticationExtensionsClientOutputs
object
Map of extension outputs from the client
3 properties
URLEncodedBase64
string
Base64url-encoded binary data
LinkIdTokenRequest
object
3 properties 2 required
SessionPayload
object
Container for session information
1 property
OKResponse
string
RelyingPartyEntity
object
2 properties 2 required
User
object
User profile and account information
14 properties 11 required
PublicKeyCredentialHints
string
Hints to help guide the user through the experience
ConveyancePreference
string
The attestation conveyance preference
AuthenticatorAssertionResponse
object
4 properties 3 required
AuthenticationExtensions
object
Additional parameters requesting additional processing by the client and authenticator
VerifyAddSecurityKeyResponse
object
2 properties 1 required
SignInWebauthnVerifyRequest
object
2 properties 1 required
UserMfaRequest
object
Request to activate or deactivate multi-factor authentication
2 properties 1 required
UserEntity
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhost-security-api-openapi.yml Raw ↑

Other APIs Nhost publishes across the network.

Nhost GraphQL API
AE Profile APIs.io
Nhost Serverless Functions API
AE Profile APIs.io
Nhost AI API
AE Profile APIs.io
Nhost authentication API
AE Profile APIs.io
Nhost documentation API
AE Profile APIs.io
Nhost excludeme API
AE Profile APIs.io
Nhost files API
AE Profile APIs.io
Nhost operations API
AE Profile APIs.io
Nhost session API
AE Profile APIs.io
Nhost storage API
AE Profile APIs.io
Nhost system API
AE Profile APIs.io
Nhost user API
AE Profile APIs.io
#Security
← Back to N APIs
API Details
ID
nhost:nhost-security-api
Base URL
https://{subdomain}.nhost.run/v1/graphql
Docs
https://docs.nhost.io/products/graphql/
Provider
Nhost
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=nhost-security-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/nhost-security-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Nhost security 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.