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

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

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.0.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.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 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), CredentialAssertionResponse (6 properties). Each schema is shown below with its type and property counts.

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

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
Nhost Serverless Functions API
Nhost AI API
Nhost authentication API
Nhost documentation API
Nhost excludeme API
Nhost files API
Nhost operations API
Nhost session API
Nhost storage API
Nhost system API
Nhost user API