Create a step-up MFA challenge

post

https://api.wingspan.app/v3/platform/mfa-challenges

Creates a step-up MFA challenge for the authenticated session and records the operation reason in requiredFor. Issue this when an operation needs additional verification, then verify the returned challenge against one of the caller’s factors.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

requiredFor

string

enum

required

Operation reason that requires verification, such as MfaFactorChange, ApiKeyChange, or StaffImpersonation.

factorId

MFA factor resource id. New factors use the canonical 22-character Wingspan id. The legacy mfa_email_ form remains accepted so factors auto-enrolled before WIN-15277 can still be acted on without rewriting persisted Spanner primary keys.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Challenge created

401Unauthenticated

403Forbidden

422Validation error