Sign up WebAuthn user
Sign up the user using the WebAuthn credential.
POST
/appid-{appId}/{tenantId}/recipe/webauthn/signupAuthorization
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.
Header parameters
cdi-versionstringX.Y of the X.Y.Z CDI version.
Request body
application/jsonwebauthnGeneratedOptionsIdstringcredentialobjectCredential returned by the browser
Responses
200The signup result
One of:
object
statusstatusOKAllowed:
OKwebauthnCredentialIdstringrelyingPartyIdstringrelyingPartyNamestringrecipeUserIdstringuserauthRecipeUserShow propertiesHide properties
iduserIdisPrimaryUserbooleantenantIdstenantId[]timeJoinedtimeJoinedemailsemail[]phoneNumbersphoneNumber[]thirdPartyobject[]Show propertiesHide properties
Array of
objectidthirdPartyIduserIdthirdPartyUserIdloginMethodsobject[]Show propertiesHide properties
Array of
objecttenantIdstenantId[]recipeUserIduserIdverifiedbooleantimeJoinedtimeJoinedrecipeIdrecipeIdAllowed:
emailpasswordpasswordlessthirdpartyemailemailphoneNumberphoneNumberthirdPartyobjectShow propertiesHide properties
idthirdPartyIduserIdthirdPartyUserIdobject
statusstringAllowed:
INVALID_OPTIONS_ERRORINVALID_AUTHENTICATOR_ERRORINVALID_CREDENTIALS_ERRORreasonstringobject
statusstringAllowed:
OPTIONS_NOT_FOUND_ERROREMAIL_ALREADY_EXISTS_ERROR400error code 400
string401error code 401
string404error code 404
string500error code 500
stringTry it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST "/appid-{appId}/public/recipe/webauthn/signup" \
-H "api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"webauthnGeneratedOptionsId": "fa7a0841-b533-4478-9253-0fde890c576",
"credential": {}
}'const response = await fetch("/appid-{appId}/public/recipe/webauthn/signup", {
method: "POST",
headers: {
"api-key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
body: JSON.stringify({
"webauthnGeneratedOptionsId": "fa7a0841-b533-4478-9253-0fde890c576",
"credential": {}
})
});import requests
response = requests.post(
"/appid-{appId}/public/recipe/webauthn/signup",
headers={
"api-key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={
"webauthnGeneratedOptionsId": "fa7a0841-b533-4478-9253-0fde890c576",
"credential": {}
},
)Response
{
"status": "OK",
"webauthnCredentialId": "fa7a0841-b533-4478-9253-0fde890c576",
"relyingPartyId": "example.com",
"relyingPartyName": "Example",
"recipeUserId": "fa7a0841-b533-4478-9253-0fde890c576",
"user": {
"id": "fa7a0841-b533-4478-95533-0fde890c3483",
"isPrimaryUser": true,
"tenantIds": [
"customer1"
],
"timeJoined": 1623918032231,
"emails": [
"[email protected]"
],
"phoneNumbers": [
"+14155552671"
],
"thirdParty": [
{
"id": "google",
"userId": 106347997792363870000
}
],
"loginMethods": [
{
"tenantIds": [
"customer1"
],
"recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
"verified": true,
"timeJoined": 1623918032231,
"recipeId": "emailpassword",
"email": "[email protected]",
"phoneNumber": "+14155552671",
"thirdParty": {
"id": "google",
"userId": 106347997792363870000
}
}
]
}
}"string""Invalid API key""Not Found""Internal Error"