Closed hjaber closed 1 month ago
In the V2 docs, I believe the old response & type for client.authenticate() is being displayed while the playground uses the newer V2 response.
client.authenticate()
The authentication docs state the response should be:
{ "credentialId": "3924HhJdJMy_svnUowT8eoXrOOO6NLP8SK85q2RPxdU", "authenticatorData": "SZYN5YgOjGh0NBcPZHZgW4_krrmihjLHmVzzuoMdl2MFAAAAAQ==", "clientData": "eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiNTY1MzViMTMtNWQ5My00MTk0LWEyODItZjIzNGMxYzI0NTAwIiwib3JpZ2luIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwIiwiY3Jvc3NPcmlnaW4iOmZhbHNlLCJvdGhlcl9rZXlzX2Nhbl9iZV9hZGRlZF9oZXJlIjoiZG8gbm90IGNvbXBhcmUgY2xpZW50RGF0YUpTT04gYWdhaW5zdCBhIHRlbXBsYXRlLiBTZWUgaHR0cHM6Ly9nb28uZ2wveWFiUGV4In0=", "signature": "MEUCIAqtFVRrn7q9HvJCAsOhE3oKJ-Hb4ISfjABu4lH70MKSAiEA666slmop_oCbmNZdc-QemTv2Rq4g_D7UvIhWT_vVp8M=" }
but the playground shows the new V2 correct response:
{ "clientExtensionResults": {}, "id": "XZg7VBiVGFZzHmC4OrTXNQ", "rawId": "XZg7VBiVGFZzHmC4OrTXNQ==", "type": "public-key", "authenticatorAttachment": "platform", "response": { "authenticatorData": "T7IIVvJKaufa_CeBCQrIR3rm4r0HJmAjbMYUxvt8LqAdAAAAAA==", "clientDataJSON": "eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiYmYxOWQ3ZjktZjk3ZS00NjEyLTg0MjYtNDYwZTExZmExOTBmIiwib3JpZ2luIjoiaHR0cHM6Ly93ZWJhdXRobi5wYXNzd29yZGxlc3MuaWQiLCJjcm9zc09yaWdpbiI6ZmFsc2V9", "signature": "MEYCIQC1FA7k7j7zf50ar9STzkanna16IkZdIYHwLNeWYWxCRwIhAITEOUcqnMC9_EHmjRxzoq3K-Titr3nWSZKY9n1yC_cL", "userHandle": "ZDUzMGYxMGQtZmI2ZS00ZjdkLTgzMTMtZWQ5N2QzYTU2ZDQ4" } }
I discovered this because credentialId is changed to id from the response of client.authenticate() which was a breaking change
credentialId
id
// obtained from database by looking up `authentication.credentialId`
interface AuthenticationResponseJSON { id: Base64URLString; rawId: Base64URLString; response: AuthenticatorAssertionResponseJSON; authenticatorAttachment?: AuthenticatorAttachment; clientExtensionResults: AuthenticationExtensionsClientOutputs; type: PublicKeyCredentialType; }
I started a PR but I wasn't able to completely to update the docs and I wasn't confident that I correctly found an issue rather than making a mistake on my end.
Thanks for reporting, I updated the docs for that part. 👍 ...There might still be a few outdated docs paragraphs lurking around. 😖
In the V2 docs, I believe the old response & type for
client.authenticate()
is being displayed while the playground uses the newer V2 response.The authentication docs state the response should be:
but the playground shows the new V2 correct response:
I discovered this because
credentialId
is changed toid
from the response ofclient.authenticate()
which was a breaking changeI started a PR but I wasn't able to completely to update the docs and I wasn't confident that I correctly found an issue rather than making a mistake on my end.