OpenPass quickstart guides

Need an easy and speedy option for installing and setting up OpenPass single sign-on (SSO) for your application? We've got you covered with our quickstart guides.

These guides will walk you through all the requirements and options you should consider.

Client-side

If you use JavaScript to integrate OpenPass with your site, when the user selects Sign In with OpenPass, you can have the site or app redirect the full page to the OpenPass Universal Login sign-in page, or open a sign-in popup window separate from the originating page. You can also embed an inline OpenPass sign-in form directly in the page.

Add "Sign In with OpenPass" Button

/v3/portal/openpass/doc/OpenPassSDKJSSignInButton

Add a customizable Sign In with OpenPass button to your site. To better match your branding, choose from an array of custom shapes, sizes, additional width spacing, text options, and themes.

Add co-branding: Inline sign-in form

/v3/portal/openpass/doc/OpenPassSDKJSInlineSignInForm

Render the sign-in form directly within a web page using an iframe for a more seamless and integrated user experience. This option also offers a better branding experience by placing the publisher's logo and display name on the first lines of the sign-in form, not next to the OpenPass brand.

Add QuickAuth sign-in form

/v3/portal/openpass/doc/OpenPassSDKJSQuickAuth

Render a QuickAuth sign-in form directly within a web page or app. With QuickAuth, users who are already signed in to OpenPass on their device can seamlessly authenticate to your website with a single click.

Custom sign-in button (add a click handler)

/v3/portal/openpass/doc/OpenPassSDKJSManualAddClickHandler

Manually add a sign-in button yourself instead of using the built-in functionality in the JavaScript SDK.

Device auth grant

/v3/portal/openpass/doc/OpenPassSDKJSDeviceAuthGrant

Integrate devices with limited input capabilities like a smart TV, game console, or Internet of Things (IoT) device.

Mobile or TV

For help with your OpenPass integration and a seamless user experience, use our comprehensive native and mobile quickstart guides. These step-by-step instructions are tailored to popular frameworks and libraries, and will help you integrate your website or app securely with our SSO solution.

Android SDK

/v3/portal/openpass/doc/OpenPassSDKAndroidGuide

Integrate OpenPass directly with your Android-based mobile or TV application.

Android TV/Fire TV SDK

/v3/portal/openpass/doc/OpenPassSDKAndroidTVGuide

Integrate OpenPass directly with your Android-based TV application, such as Fire TV.

iOS SDK

/v3/portal/openpass/doc/OpenPassSDKiOSGuide

Integrate OpenPass directly with your iOS or iPadOS application.

tvOS SDK

/v3/portal/openpass/doc/OpenPassSDKtvOSGuide

Integrate OpenPass directly with your tvOS application.

Unity SDK

/v3/portal/openpass/doc/OpenPassSDKUnityGuide

Integrate OpenPass with your Unity project on Android and iOS platforms.

Roku SDK

/v3/portal/openpass/doc/OpenPassSDKRokuTVGuide

Integrate OpenPass directly with your Roku channel.

Third-party frameworks

Make SSO user-friendly and seamless by configuring OpenPass as an authentication provider using a third-party framework.

Next.js

/v3/portal/openpass/doc/OpenPassNextJsGuide

Configure OpenPass as an authentication provider using the NextAuth.js plugin for the Next.js web framework.

Passport.js

/v3/portal/openpass/doc/OpenPassPassportGuide

Configure OpenPass as an authentication provider using Passport.js with OpenID Connect.

API

Make the user experience for your web or mobile app seamless and secure by implementing code for various functions using our API endpoints.

TIP: The Trade Desk recommends using an SDK because it is the easiest option. It can do a lot of the work for you, such as managing security features and returning the user's ID token and access token.

API authentication: Authorization code flow

/v3/portal/openpass/doc/OpenPassAPIGuide

Get up and running with the OpenPass API using the redirect flow for web apps.

API authentication: Device grant flow

/v3/portal/openpass/doc/OpenPassAPIDeviceAuthorization

Use this installation guide for devices with limited input capabilities like a smart TV, game console, or Internet of Things (IoT) device.

Cloud-based providers

Simplify your user access with seamless integrations for leading cloud-based identity and access management providers. Follow these step-by-step instructions for configuring OpenPass SSO and enabling a smooth and secure login experience for your users.

Amazon Cognito

/v3/portal/openpass/doc/OpenPassAmazonCognito

Integrate OpenPass with Cognito to securely authenticate users with other services that support OIDC-identity providers.

Auth0

/v3/portal/openpass/doc/OpenPassAuth0

Integrate OpenPass with Okta's Auth0 to securely authenticate users and connect them to an OAuth2 authorization server.

Google Cloud Platform

/v3/portal/openpass/doc/OpenPassGoogleCloudPlatform

Integrate OpenPass with Google Cloud Identity and Firebase to securely authenticate users. This activates the OpenPass connection for your application in your Google Cloud Platform domain, enabling organizations to quickly onboard and use OpenPass as an identity solution option.