Authentication/com.transmit.authentication/TSAuthentication

TSAuthentication

TS Authentication user API

Functions

fun approvalNativeBiometrics(context: FragmentActivity, userName: String, challenge: String, promptTexts: BiometricPromptTexts, callback: TSAuthCallback<TSNativeBiometricsApprovalResult, TSNativeBiometricsApprovalError>)

Authenticate the user with native biometrics to authorize a specific action. If successful, returns a signed challenge that must be sent to your backend to complete the approval.

approvalWebAuthn

@JvmStatic

fun approvalWebAuthn(context: Context, webAuthnAuthenticationData: TSWebAuthnAuthenticationData, callback: TSAuthCallback<TSWebAuthnApprovalResult, TSWebAuthnApprovalError>)

Authenticate the user with WebAuthn biometrics to authorize a specific action, using explicit credential request data. If successful, returns a signed result that must be sent to your backend to complete the approval.

@JvmStatic

fun approvalWebAuthn(context: Context, userName: String?, approvalData: Map<String, String>, callback: TSAuthCallback<TSWebAuthnApprovalResult, TSWebAuthnApprovalError>)

Authenticate the user with WebAuthn biometrics to authorize a specific action. If successful, returns a signed result that must be sent to your backend to complete the approval.

authenticateNativeBiometrics

@JvmStatic

fun authenticateNativeBiometrics(context: FragmentActivity, username: String, challenge: String, promptTexts: BiometricPromptTexts, callback: TSAuthCallback<TSBiometricsAuthResult, TSBiometricsAuthError>)

Authenticate a user by prompting for biometrics and signing the provided challenge. On success, returns a signed challenge that must be sent to your backend to complete authentication.

authenticatePinCode

@JvmStatic

fun authenticatePinCode(userID: String, pinCode: String, challenge: String, callback: TSAuthCallback<TSPinCodeAuthenticationResult, TSPinCodeAuthenticationError>)

Authenticate user with Pin Code authenticator.

authenticateWebAuthn

@JvmStatic

fun authenticateWebAuthn(context: Context, webAuthnAuthenticationData: TSWebAuthnAuthenticationData, callback: TSAuthCallback<AuthenticationResult, TSWebAuthnAuthenticationError>)

@JvmStatic

fun authenticateWebAuthn(context: Context, userName: String? = "", callback: TSAuthCallback<AuthenticationResult, TSWebAuthnAuthenticationError>)

Authenticate the user using WebAuthn credentials. If the username is not provided, all the credentials for this app in this device will be displayed. This will prompt the user for biometrics. If successful, it returns a webauthn authentication result encoded as a base64 string, which is required to complete the authentication via your backend.

generateTOTP

@JvmStatic

fun generateTOTP(context: Context, uuid: String, callback: ITSTOTPGenerateTOTPCallback)

Generate a time-based TOTP code for a previously registered authenticator.

generateTOTPWithChallenge

@JvmStatic

fun generateTOTPWithChallenge(context: Context, uuid: String, challenge: String, callback: ITSTOTPGenerateTOTPCallback)

Generate a challenge-based TOTP code for a previously registered authenticator.

getDeviceInfo

@JvmStatic

fun getDeviceInfo(context: Context, callback: TSAuthCallback<DeviceInfo, TSDeviceInfoError>)

Retrieve information about the current device, including its registration status and public key.

getNativeBiometricsStatus

@JvmStatic

fun getNativeBiometricsStatus(context: Context): TSNativeBiometricsStatus

Returns the current native biometrics availability status for the device.

initialize

@JvmStatic

fun initialize(context: Context, clientID: String)

Initialize the SDK using the default API base URL ("https://api.transmitsecurity.io/").

@JvmStatic

fun initialize(context: Context, clientID: String, baseUrl: String, domain: String? = null, initOptions: TSAuthenticationInitOptions? = null)

Initialize the SDK.

initializeSDK

@JvmStatic

fun initializeSDK(context: Context)

Initialize the SDK. Client ID and base url values are fetched from app's string resources (transmit_security_client_id and transmit_security_base_url)

isWebAuthnSupported

@JvmStatic

fun isWebAuthnSupported(): Boolean

Returns whether the current device supports WebAuthn (FIDO2) authentication. Returns false if the SDK has not been initialized.

registerNativeBiometrics

@JvmStatic

fun registerNativeBiometrics(context: Context, username: String, callback: TSAuthCallback<TSBiometricsRegistrationResult, TSBiometricsRegistrationError>)

Register the device's biometrics as an authenticator for the given user. On success, returns a signed public key that must be sent to your backend to complete registration.

registerPinCode

@JvmStatic

fun registerPinCode(userID: String, pinCode: String, callback: TSAuthCallback<TSPinCodeRegistrationResult, TSPinCodeRegistrationError>)

registerTOTP

@JvmStatic

fun registerTOTP(context: Context, totpURI: String, securityType: TSTOTPSecurityType, callback: ITSRegisterTOTPCallback)

registerWebAuthn

@JvmStatic

fun registerWebAuthn(context: Context, credentialsCreationOptions: TSWebAuthnRegistrationData, callback: TSAuthCallback<RegistrationResult, TSWebAuthnRegistrationError>)

@JvmStatic

fun registerWebAuthn(context: Context, userName: String, displayName: String?, callback: TSAuthCallback<RegistrationResult, TSWebAuthnRegistrationError>)

Register credentials with WebAuthn, including prompting the user for biometrics. If successful, returns a webauthn registration result encoded as a base64 string, which is required to complete the registration via your backend.

setLoggingEnabled

@JvmStatic

fun setLoggingEnabled(enableLogs: Boolean)

Enable or disable SDK logging. Disabled by default.

signTransactionWebAuthn

@JvmStatic

fun signTransactionWebAuthn(context: Context, webAuthnAuthenticationData: TSWebAuthnAuthenticationData, callback: TSAuthCallback<AuthenticationResult, TSWebAuthnAuthenticationError>)

Sign a WebAuthn transaction using explicit credential request data. Prompts the user for biometrics and returns a signed result that must be sent to your backend.

@JvmStatic

fun signTransactionWebAuthn(context: Context, userName: String?, callback: TSAuthCallback<AuthenticationResult, TSWebAuthnAuthenticationError>)

Sign a WebAuthn transaction for the given user. Prompts the user for biometrics and returns a signed result that must be sent to your backend.

signWithDeviceKey

@JvmStatic

fun signWithDeviceKey(context: Context, challenge: String, callback: TSAuthCallback<TSSignResult, TSSignError>)

Sign a challenge with the device key.

unregisterNativeBiometrics

@JvmStatic

fun unregisterNativeBiometrics(context: Context, userID: String, callback: TSAuthCallback<TSBiometricsUnregistrationResult, TSBiometricsUnregistrationError>)

Unregister the biometric credential for the given user, removing it from the device.

unregisterPinCode

@JvmStatic

fun unregisterPinCode(userID: String, callback: TSAuthCallback<TSPinCodeUnregistrationResult, TSPinCodeUnregistrationError>)

Unregister the pin code authenticator for the given user.