Get WebAuthn options
Get the WebAuthn options.
GET
/appid-{appId}/{tenantId}/recipe/webauthn/optionsAuthorization
api-keyAPI key · headerrequiredThe core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.
Path parameters
tenantIdstringThe tenant against which the request is made. If left empty, the default tenant will be used.
Query parameters
webauthnGeneratedOptionsIdstringrequiredHeader parameters
cdi-versionstringX.Y of the X.Y.Z CDI version.
Responses
200WebAuthn options result
One of:
object
statusstatusOKAllowed:
OKwebauthnGeneratedOptionsIdstringrelyingPartyIdstringrelyingPartyNamestringchallengestringtimeoutnumberoriginstringemailstringuserVerificationstringuserPresencebooleancreatedAtnumberexpiresAtnumber400error code 400
string401error code 401
string404error code 404
string500error code 500
stringTry it
Server
Authorization
Parameters
Request
curl -X GET "/appid-{appId}/public/recipe/webauthn/options?webauthnGeneratedOptionsId=fa7a0841-b533-4478-9253-0fde890c576" \
-H "api-key: YOUR_API_KEY"const response = await fetch("/appid-{appId}/public/recipe/webauthn/options?webauthnGeneratedOptionsId=fa7a0841-b533-4478-9253-0fde890c576", {
method: "GET",
headers: {
"api-key": "YOUR_API_KEY"
}
});import requests
response = requests.get(
"/appid-{appId}/public/recipe/webauthn/options?webauthnGeneratedOptionsId=fa7a0841-b533-4478-9253-0fde890c576",
headers={
"api-key": "YOUR_API_KEY"
},
)Response
{
"status": "OK",
"webauthnGeneratedOptionsId": "fa7a0841-b533-4478-9253-0fde890c576",
"relyingPartyId": "example.com",
"relyingPartyName": "Example",
"challenge": "TQvEVDV8B64w_2zIifzKaPzBPfthqpx2uJkq_2PIB0k",
"timeout": 10000,
"origin": "http://example.com",
"email": "[email protected]",
"userVerification": "required",
"userPresence": true,
"createdAt": 1741793746,
"expiresAt": 1741793746
}"string""Invalid API key""Not Found""Internal Error"