OpenPass account management
To manage your OpenPass implementations, use the self-serve OpenPass Account Management portal. From the portal, you can set up and manage applications, monitor data, and optionally integrate with other apps (such as Ventura TV OS) to keep them in sync with OpenPass user data.
IMPORTANT: To create an account and access the portal, you must first register with OpenPass.
The following table describes the two main sections for navigation.
| Section | Description |
|---|---|
| Applications Overview | This page provides an overview of your integrated applications with OpenPass. It includes key information for each application, including the following:
|
| Application Management | This page helps you manage all aspects of your individual application integration with OpenPass, including the following:
|
Through the portal, you can perform application management tasks described in the following sections.
For more information, see OpenPass documentation. If you have questions or need help, contact your OpenPass representative.
Sign in and out
All registered organizations can log in to the portal using their Trade Desk credentials. If you have issues creating or managing your credentials, contact your OpenPass representative.You can sign out of the portal by clicking Sign Out at the bottom-left corner of the UI.
Create an application
Creating an application is simple. Just do the following:- On the Applications page, choose your application type (web, mobile, or TV).
- On the setup page, follow the instructional text to enter application details correctly and start your integration.
NOTE: Each field has instructional text to help you enter the correct information.
After completing these steps, the Application Management page for this application opens. This is where you can find your client ID and secret (if needed).
View credentials and generate a new client secret
You can find your client ID and secret (if necessary) in the Application Management page for your respective application. Your credentials are displayed after the application name. If you need to generate a new client secret, click **Generate New Client Secret**.NOTE: If you generate a new client secret, you must also update your integration credentials to prevent breaking the OpenPass service.
Manage an application
To manage your application, do the following:- On the Applications page, click the name of the desired application. This opens the Application Management page.
- In the Application Management page, edit and save your integration configurations.
Change application type
>**IMPORTANT**: Changing the application type resets the application fields. Any unsaved values will be lost.To change your application type (web, mobile, or TV), go to the Application Management page and select an icon in the Application Type section.
Collect user information
To collect more information from OpenPass users, activate the relevant features in the Application Management page.
NOTE: OpenPass users can edit their details later at myopenpass.com.
OpenPass supports collecting the following user information:
| User Information | Required/Optional |
|---|---|
| First (given) name | Required |
| Last name (surname) | Required only for Ventura TV OS |
| Full name (alternative, more flexible option) | Required only for Ventura TV OS |
For details on how user names are represented, see JWT payload.
Get real-time insights
To find trends and get real-time insights about OpenPass performance, in the Insights tab, select an application and desired time range (last month, last year, or all time). Line and bar graphs with the following data are displayed:
- Number of unique users
- Authentication rate
- Browser usage
- Device type usage
- Platform usage
For details, hover your mouse cursor over different elements in the charts.
If you encounter technical issues or want new metrics, email support@myopenpass.com. A representative from The Trade Desk will reach out to you.
Delete an application
To delete your application, in the Application Management page for your respective application, click **Delete Application**. A confirmation dialog appears before the application is permanently deleted.If you delete your application by mistake, create a new application to replace it. This will generate new credentials that will need to be updated in your integration.
Share security events with other apps
To notify connected applications, such as Ventura TV OS, about security-related changes to user accounts and sessions, use the Shared Signals Framework (SSF) webhook. When this option is enabled, OpenPass transmits security events (SETs) to your application so it can respond to events such as profile updates, email address updates, and account deletions. To enable this feature, do the following:
- In the Shared Signals Framework section of the portal, click Enable OpenPass to send user updates to this application.
- In the Webhook URL field, enter the HTTPS endpoint where OpenPass should SETs.
- Verify the connection by clicking Test webhook. A success or failure message appears.
If the test fails, a warning message appears and you receive an email from OpenPass with additional details. Follow the instructions in both the warning message and the email to resolve the issue.
View recent webhook events
To monitor the health of the SSF webhook and troubleshoot delivery issues, review the Recent Webhook Events table. It logs the most recent webhook delivery attempts, with each row representing a single event and its delivery outcome. Here's what you need to know about webhook events:
- Events are delivered within approximately 90 seconds of the triggering user action. The service polls the queue every minute.
- If delivery fails, OpenPass retries up to three times at 15-minute intervals.
- Delivery failures are isolated per client. One webhook's failure does not affect others.
- Test events are not included in the Recent Webhook Events table.
The table can include the following event types:
| Event type | URI | Updated claims keys | Description |
|---|---|---|---|
| Profile updated | <url>/events/profile-updated |
|
The user updated profile information, such as their first or last name. NOTE: This event type shows either the name field or one or both of the given_name and family_name fields, but it will never show the name field together with the others. |
| Email changed | <url>/events/email-changed |
email (always present) |
The user changed their primary email address. |
| Account deleted | <url>/events/account-deleted |
None | The user deleted their OpenPass account. |
| Connection revoked | <url>/events/connection-revoked |
None | The user revoked the connection between OpenPass and the client application through the OpenPass consumer portal. |
| Test webhook | <url>/events/test-webhook |
None | A test event used to validate the client webhook configuration. This event contains no user data. |
The table can include the following delivery statuses:
| Status | Description |
|---|---|
| Delivered | The webhook was successfully sent and acknowledged. |
| Failed | The delivery attempt was unsuccessful. |
The following is a screenshot of the Recent Webhook Events table. To view the full error message in the Last Error column, hover over the word More.