Get available elevation methods

GET

/elevate

• Nhost Authentication API Server

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

Authorizations

• BearerAuth

Responses

200

Available elevation methods

Elevation status of the user

object

elevationRequired

required

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

boolean

Example

true

methods

required

Methods the user can use to elevate their session

Array<string>

Allowed values: webauthn totp

Example

[
  "webauthn",
  "totp"
]

sessionElevated

required

Whether the bearer token has an elevated claim matching its subject

boolean

default

An error occurred while processing the request

Standardized error response

object

status

required

HTTP status error code

integer

Example

400

message

required

Human-friendly error message

string

Example

Invalid email format

error

required

Error code identifying the specific application error

string

Allowed values: default-role-must-be-in-allowed-roles disabled-endpoint disabled-user user-already-exists email-already-verified forbidden-anonymous internal-server-error invalid-email-password invalid-request locale-not-allowed password-too-short password-in-hibp-database redirectTo-not-allowed role-not-allowed signup-disabled unverified-user user-not-anonymous invalid-pat invalid-refresh-token invalid-ticket disabled-mfa-totp no-totp-secret invalid-totp mfa-type-not-found totp-already-active invalid-state oauth-token-echange-failed oauth-profile-fetch-failed oauth-provider-error invalid-otp otp-too-many-attempts cannot-send-sms provider-account-already-linked