Get WebAuthn sign in options
POST
/{apiBasePath}/{tenantId}/webauthn/signin/optionsPath parameters
apiBasePathstringrequiredIts value depends on the apiBasePath set by the user
tenantIdstringThe tenant against which the request is made. If left empty, the default tenant will be used.
Header parameters
ridstringThe WebAuthn recipe ID
Responses
200WebAuthn sign in options
One of:
object
statusstatusOKSuccess status indicator
Allowed:
OKwebauthnGeneratedOptionsIdstringcreatedAtstringexpiresAtstringrpIdstringchallengestringtimeoutnumberuserVerificationstringAllowed:
requiredpreferreddiscouragedgeneralErrorResponse
statusstringError status code
Allowed:
GENERAL_ERRORmessagestringError message
object
statusstringAllowed:
INVALID_OPTIONS_ERROR404Resource not found error
string500Internal server error
stringTry it
Server
Parameters
Request
curl -X POST "/auth/public/webauthn/signin/options"const response = await fetch("/auth/public/webauthn/signin/options", {
method: "POST"
});import requests
response = requests.post(
"/auth/public/webauthn/signin/options",
)Response
{
"status": "OK",
"webauthnGeneratedOptionsId": "opt_123...",
"createdAt": "2024-03-20T10:00:00Z",
"expiresAt": "2024-03-20T10:05:00Z",
"rpId": "example.com",
"challenge": "base64challenge...",
"timeout": 300000,
"userVerification": "required"
}"Not Found""Internal Error"