OpenPass SDK for iOS overview
This guide is for developers integrating OpenPass authentication with iOS and tvOS devices. For a successful integration, you must do the following:
- Meet the requirements.
- Choose the quickstart guide for your platform, iOS or tvOS.
- Review the API reference guide.
Requirements
The minimum requirements for installing the SDK are the following:
iOS 13 for mobile devices
tvOS 16 for TVs
Releases
For details, see the changelog.
Authentication flow
This SDK enables users to use SSO for authenticating their identity on your site or app. Choosing a flow is an important part of it.
| Flow | Description |
|---|---|
| Mobile | The sign-in flow for iOS and iPadOS uses Apple's ASWebAuthenticationSession to launch the sign-in experience. After the user has signed in, the web component redirects to the application with the necessary information. |
| TV | The sign-in flow for tvOS uses Apple's ASWebAuthenticationSession to launch the sign-in experience, the same as for mobile. After the user starts the sign-in process in your tvOS app (usually through a button press), Apple TV will search for an iPhone or iPad nearby to continue to process through the web component. When completed, the iPhone or iPad redirects to the Apple TV with the authenticated data. |
Documentation
SDK documentation includes the following guides:
- iOS Quickstart Guide
- tvOS Quickstart Guide
- Reference guide
- Sample App
To make the user experience consistent and enjoyable, we also provided you with OpenPass Integration best practices and co-branding guidelines. The latter includes a ZIP file with SVG logos and other web assets.