Saltar al contenido
NimbusNexus

Two-factor authentication

Two-factor authentication adds a second factor (TOTP code from an authenticator app, or a WebAuthn passkey) on top of password login. The endpoints here cover enrollment, listing devices, removing devices, and downloading recovery codes.

For dashboard users, 2FA is browser-driven from the account settings page; the API surface here is for automation (provisioning a new admin user, programmatically rotating recovery codes, enforcing org-wide 2FA before a compliance audit). API-key callers don't need 2FA — keys are themselves a "something you have" factor; 2FA gates the human dashboard login path.

Strong recommendation: enable 2FA on every human account with role grants on production projects. Most account compromises trace to password reuse + no second factor.

What's next

Reference

GET/api/v1/2fa/credential

Two Factor Credential

Generate a TOTP secret for the calling user and return its QR-code image; the secret is delivered in a response header.

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/2fa/credential

POST/api/v1/2fa/off

Two Factor Off

Disable two-factor authentication for the calling user.

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/2fa/off

GET/api/v1/2fa/status

Two Factor Status

Report whether two-factor authentication is currently enabled for the calling user.

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/2fa/status

POST/api/v1/2fa/totp_passcode_validation

Totp Passcode Validation

Validate a TOTP passcode against the supplied secret and enable two-factor authentication on success.

Request body

JSON body required.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 429Too Many Requests
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/2fa/totp_passcode_validation

Need to make a real call? Try these endpoints in the live Swagger UI →