Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Step up

POST
/api/v1/auth/step-up
curl --request POST \
  --url https://example.com/api/v1/auth/step-up \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "code": "example", "method": "totp", "password": "example" }'

Prove it’s you again on this session, for the actions guarded by require_recent_authentication: a TOTP code when the account has TOTP (backup codes don’t count – they reset enrollment), an email code (method=“email”) when it has that factor – the only way when it’s its one factor – else the password. An account with none of them (single sign-on only) goes back to the provider (POST /auth/oidc/step-up).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
StepUpRequest
object
code
Any of:
string
<= 32 characters
method
Any of:
string
Allowed values: totp email
password
Any of:
string
<= 1024 characters

Responses

Section titled “Responses”

204

Section titled “204”

Successful Response

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}