Get credential creation options as per the given request.

Prev Next
Post
/sys/v1/session/config_2fa/new_challenge

The response of this API needs to be used with relevant API for the protocol. For U2F, it is u2f.register(). For FIDO2, it is navigator.credentials.create().

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Query parameters
MfaChallengeParams
object
protocol
string Required
Valid values[ "u2f", "fido2" ]
Responses
2XX

Success result

Expand All
OneOf
object
object
u2f_challenge
string
u2f_keys
Array of object (U2fRegisteredKey)
object
keyHandle
string
version
string
object
OneOf
object
object
rp
object
name
string
entity
object
id
string | null
user
object
name
string
entity
object
id
string (byte)
displayName
string
challenge
string (byte)
pubKeyCredParams
Array of object (PublicKeyCredentialParameters)
object
type
string
Valid values[ "public-key" ]
alg
string
Valid values[ "Es256" ]
timeout
integer | null
excludeCredentials
Array of object (PublicKeyCredentialDescriptor)
object
type
string
Valid values[ "public-key" ]
id
string (byte)
transports
Array
OneOf
string
string
Valid values[ "usb", "nfc", "ble", "internal" ]
string
string
authenticatorSelection
object
authenticatorAttachment
string
Valid values[ "platform", "cross-platform" ]
residentKey
string
Valid values[ "discouraged", "preferred", "required" ]
requireResidentKey
boolean | null
userVerification
string
Valid values[ "required", "preferred", "discouraged" ]
attestation
string
Valid values[ "none", "indirect", "direct", "enterprise" ]
extensions
object
appidExclude
string | null
appid
string | null
example.extension.bool
boolean | null
object
object
challenge
string (byte)
timeout
integer | null
rpId
string | null
allowCredentials
Array of object | null
object
type
string
Valid values[ "public-key" ]
id
string (byte)
transports
Array
OneOf
string
string
Valid values[ "usb", "nfc", "ble", "internal" ]
string
string
userVerification
string
Valid values[ "required", "preferred", "discouraged" ]
extensions
object
appidExclude
string | null
appid
string | null
example.extension.bool
boolean | null