Interface Passkeys
-
- All Implemented Interfaces:
public interface PasskeysThe Passkeys interface provides methods for detecting Passkeys support, registering, and authenticating with Passkeys.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classPasskeys.RegisterParametersData class used for wrapping parameters used with Passkeys registration
public final classPasskeys.AuthenticateParametersData class used for wrapping parameters used with Passkeys authentication
public final classPasskeys.UpdateParametersData class used for wrapping parameters used with Passkeys updates
-
Method Summary
Modifier and Type Method Description abstract StytchResult<WebAuthnRegisterData>register(Passkeys.RegisterParameters parameters)Creates a new Passkey registration. abstract Unitregister(Passkeys.RegisterParameters parameters, Function1<StytchResult<WebAuthnRegisterData>, Unit> callback)Creates a new Passkey registration. abstract CompletableFuture<StytchResult<WebAuthnRegisterData>>registerCompletable(Passkeys.RegisterParameters parameters)Creates a new Passkey registration. abstract StytchResult<IAuthData>authenticate(Passkeys.AuthenticateParameters parameters)Authenticates a Passkey registration. abstract Unitauthenticate(Passkeys.AuthenticateParameters parameters, Function1<StytchResult<IAuthData>, Unit> callback)Authenticates a Passkey registration. abstract CompletableFuture<StytchResult<IAuthData>>authenticateCompletable(Passkeys.AuthenticateParameters parameters)Authenticates a Passkey registration. abstract StytchResult<WebAuthnUpdateResponseData>update(Passkeys.UpdateParameters parameters)Updates a Passkey registration. abstract Unitupdate(Passkeys.UpdateParameters parameters, Function1<StytchResult<WebAuthnUpdateResponseData>, Unit> callback)Updates a Passkey registration. abstract CompletableFuture<StytchResult<WebAuthnUpdateResponseData>>updateCompletable(Passkeys.UpdateParameters parameters)Updates a Passkey registration. abstract BooleanisSupported()Indicates if Passkeys is supported on the device. -
-
Method Detail
-
register
abstract StytchResult<WebAuthnRegisterData> register(Passkeys.RegisterParameters parameters)
Creates a new Passkey registration.
- Parameters:
parameters- required to register a Passkey- Returns:
WebAuthnRegisterResponse
-
register
abstract Unit register(Passkeys.RegisterParameters parameters, Function1<StytchResult<WebAuthnRegisterData>, Unit> callback)
Creates a new Passkey registration.
- Parameters:
parameters- required to register a Passkeycallback- a callback that receives a WebAuthnRegisterResponse
-
registerCompletable
abstract CompletableFuture<StytchResult<WebAuthnRegisterData>> registerCompletable(Passkeys.RegisterParameters parameters)
Creates a new Passkey registration.
- Parameters:
parameters- required to register a Passkey- Returns:
WebAuthnRegisterResponse
-
authenticate
abstract StytchResult<IAuthData> authenticate(Passkeys.AuthenticateParameters parameters)
Authenticates a Passkey registration.
- Parameters:
parameters- required to authenticate a Passkey registration- Returns:
AuthResponse
-
authenticate
abstract Unit authenticate(Passkeys.AuthenticateParameters parameters, Function1<StytchResult<IAuthData>, Unit> callback)
Authenticates a Passkey registration.
- Parameters:
parameters- required to authenticate a Passkey registrationcallback- a callback that receives a AuthResponse
-
authenticateCompletable
abstract CompletableFuture<StytchResult<IAuthData>> authenticateCompletable(Passkeys.AuthenticateParameters parameters)
Authenticates a Passkey registration.
- Parameters:
parameters- required to authenticate a Passkey registration- Returns:
AuthResponse
-
update
abstract StytchResult<WebAuthnUpdateResponseData> update(Passkeys.UpdateParameters parameters)
Updates a Passkey registration.
- Parameters:
parameters- required to update a Passkey registration- Returns:
WebAuthnUpdateResponse
-
update
abstract Unit update(Passkeys.UpdateParameters parameters, Function1<StytchResult<WebAuthnUpdateResponseData>, Unit> callback)
Updates a Passkey registration.
- Parameters:
parameters- required to update a Passkey registrationcallback- a callback that receives a WebAuthnUpdateResponse
-
updateCompletable
abstract CompletableFuture<StytchResult<WebAuthnUpdateResponseData>> updateCompletable(Passkeys.UpdateParameters parameters)
Updates a Passkey registration.
- Parameters:
parameters- required to update a Passkey registration- Returns:
WebAuthnUpdateResponse
-
isSupported
abstract Boolean isSupported()
Indicates if Passkeys is supported on the device.
-
-
-
-