Getting started with OpenPass

OpenPass is a streamlined single sign-on (SSO) solution that helps consumers view content in exchange for personalized advertising. With this solution, consumers can access premium content across the open internet using just their email addresses.

NOTE: Account creation and legal documents are managed by the team at The Trade Desk.

Process overview

The following table outlines major decisions and steps in the implementation process.
Step Decision Notes
1 Set up your OpenPass account with The Trade Desk. This includes completing legal documents and providing values and assets such as your logo and redirect URIs.
2 Decide whether to implement OpenPass with one of our SDKs, or code the various functions yourself using our API endpoints. You should use 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.
NOTE: More languages and frameworks are planned for future support. For details, ask your Technical Account Manager at The Trade Desk.
3 Decide which flow you want to use. Each SDK and API guide has a set of flows for sign-in and authorization for you to choose from.
  • Android: You can use a custom tab to redirect the user in a web application, or send a code to another device for authenticating through a connected TV.
  • iOS: With the help of this SDK, you can handle the authentication response that is optimized for mobile or TV-based interfaces to sign in a user.
  • JavaScript: When the user selects Sign In with OpenPass, there are various options for login display and authentication flow. Choose the quickstart guide for the option that works best for your website or app.
    TIP: The Trade Desk recommends the popup flow for single-page applications (SPAs) or sites where navigating away from the current page is not optimal.
  • Third-Party SDKs: OpenPass is fully OIDC compliant, so it works with off-the-shelf OIDC libraries such as: Next.js next auth, Java vertx, and Asp.net core.
  • API: You can use the redirect flow for web apps, or the device grant flow for apps built for smart TVs and similar devices.
4 Test the installation. Every quickstart guide has instructions for observing and validating user authentication.

Account setup

To create an account with TTD, complete the OpenPass Registration Request form by providing the information listed in the following table. If you have problems submitting the form, contact support@myopenpass.com. A representative from The Trade Desk will guide you through the process.

The following table describes some of the information needed for account setup.

Information Type Description Examples
Client name The application or organization's name for registration. "Your Site"
Friendly website URL A short and simple URL that sends the user to a longer web address. https://www.yoursite.com/
Type of Application A category of software designed to help users perform specific tasks. Web application
Redirect URIs One or more valid URIs that OpenPass redirects to when a user has completed the sign-in process.
The redirect URI sent during the authentication process must match one of the redirect URLs provided for the account. See Redirect URIs.
NOTE: To improve security, use dedicated client registrations for each environment, such as developer, test, and production. Do not add redirect URIs of different environments under the same client registration.		 https://yoursite.com/op_callback
https://localhost:8000/op_callback
Client logo Your application or organization's logo to be displayed in the sign-in form. Here are some guidelines:
  • Make sure the logo has a transparent or white background.
  • Use an SVG file so that it scales appropriately on any viewing device.
  • If SVG is not available, use the PNG format. We recommend a maximum resolution of 320 x 100 px.
 logo.svg
Link to your privacy statement A document that specifies a website's data collection and usage. https://www.yoursite.com/privacy-policy
Link to your terms of service A document that specifies the legal agreements between the service provider and a user. https://www.yoursite.com/terms-and-conditions

When your account is set up, you will receive the following from The Trade Desk.
Information Type Description
Unique client ID This value is your unique identifier with OpenPass and is required for setting up your SDK client or calling the OpenPass API directly.
Client secret value NOTE: The client secret value applies only to web application types, which are used for server-side integrations.

This value is the equivalent of an account password. Store and share it using only secure methods.

SDK vs. API

You can integrate your website or app with OpenPass in different ways. 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. However, you could also manually implement code for various functions using our API endpoints instead of an SDK.

For a list of the quickstart guides available, see OpenPass quickstart guides.

Managing user sessions

When a user signs in to their OpenPass account, their JSON Web Token (JWT) credentials containing their email address is returned to you. Using these credentials, you can use the email address to create a user account in your system or sign the user in to their existing account. You can then manage their sign-in status on your site.

After the user logs in, their OpenPass account and sign-in status in your application work independently. The user can stay signed in to your application, even if they log out or switch OpenPass accounts.