OwnID Android SDK

The OwnID Android SDK is a client library that offers a secure and passwordless login alternative for your Android applications. By leveraging Passkeys, it replaces conventional passwords and enhances authentication methods. Packaged as an Android library (.aar), this SDK enables users to seamlessly execute registration and login flows within their native Android applications.

Key components of the OwnID Android SDK:

• OwnID Core - Provides fundamental functionalities such as SDK configuration, UI widgets, interaction with the Android system, and returning OwnID results to the Android application. It also provide two variants:

  • Boost - designed to enhance your existing login and registration forms by adding OwnID widget as an add-on.
  • Elite - provides predefined authentication screens that can be easily customized with your brand’s look and feel.

• OwnID Integration Component - An optional extension of the Core SDK, designed for seamless integration with identity platforms on the native side. When present, it executes the actual registration and login processes into the identity platform.

To integrate OwnID with your identity platform, you have three pathways:

• Direct Integration - Handle OwnID Response data directly without using the Integration component.

• Custom Integration - Develop your OwnID Integration component tailored to your identity platform.

• Prebuilt Integration - Utilize the existing OwnID SDK with a prebuilt Integration component. Options include:

  • OwnID Gigya - Expands Core SDK functionality by offering a prebuilt Gigya Integration, supporting Email/Password-based Gigya Authentication. It also includes the OwnID WebView Bridge, enabling native Passkeys functionality for Gigya Web Screen-Sets with OwnID Web SDK.

Additional Components:

• OwnID Compose - Extends OwnID Core SDK by providing an Android Compose wrapper for OwnID UI widgets.

• OwnID WebView Bridge - A Core SDK component that introduces native Passkeys functionality to the OwnID Web SDK when running within an Android WebView.

• OwnID Redirect - Help Android app that use WebView or CustomTab with OwnID WebApp to redirect back from browser to native app.

Advanced Configuration

Explore advanced configuration options in OwnID Core Android SDK by referring to the Advanced Configuration documentation.

Demo applications

This repository hosts various OwnID Demo applications, each showcasing integration scenarios:

• Direct Handling of OwnID Response: demo-integration module exemplifies the integration process by directly handling OwnID Response.

• Gigya Integration Demos:

  • demo-gigya module provides an example of Gigya integration using Kotlin.
  • demo-gigya-compose module provides an example of Gigya integration with Android Compose.
  • demo-gigya-java module provides an example of Gigya integration using Java.

• Gigya Web Screen-Sets with WebView Bridge Demo: demo-gigya-screens module.

• Redirect Demo for Gigya Web Screen-Sets Integration: demo-redirect module.

The demo-common module contains common code for all demo applications.

You can run these demo apps on a physical Android device or an emulator.

Supported Languages

The OwnID SDK has built-in support for multiple languages. The SDK loads translations in runtime and selects the best language available. The list of currently supported languages can be found here.

The SDK will also make the RTL adjustments if needed. If the user's mobile device uses a language that is not supported, the SDK displays the UI in English.

Data Safety

The OwnID SDK collects data and information about events inside the SDK using Log Data. This Log Data does not include any personal data that can be used to identify the user such as username, email, and password. It does include general information like the device Internet Protocol (“IP”) address, device model, operating system version, time and date of events, and other statistics.

Log Data is sent to the OwnID server using an encrypted process so it can be used to collect OwnID service statistics and improve service quality. OwnID does not share Log Data with any third party services.

Feedback

We'd love to hear from you! If you have any questions or suggestions, feel free to reach out by creating a GitHub issue.

License

Copyright 2023 OwnID INC.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.