NHnhost
security

Get available elevation methods

Changed on

List the authenticated user's available elevation methods, whether elevation is required under the configured mode, and whether the current session is elevated.

get/elevate

Request

  • Base URL
    https://{subdomain}.auth.{region}.nhost.run/v1
  • URL
    https://{subdomain}.auth.{region}.nhost.run/v1/elevate
  • Auth
    HTTP bearer

Response

Available elevation methods

elevationRequiredboolean required

Whether protected endpoints require an elevated session. When true and no methods are available, the user must set up a second factor first

methodsElevationMethod[] required

Methods the user can use to elevate their session

sessionElevatedboolean required

Whether the bearer token has an elevated claim matching its subject

Example response

{
  "elevationRequired": true,
  "methods": [
    "webauthn",
    "totp"
  ]
}

Changes

  • ba714d949d74Revision changes
    • warning

      added the new otp-sms enum value to the / response property for the response status

  • cf47251ddcfaRevision changes
    • warning

      added the new otp-email enum value to the / response property for the response status