navigator.id Redirect 1

« DOM Reference

Not native
This feature is not built into all browsers. To use it reliably, you'll need to include a JavaScript library in your page as a polyfill. You can include the library from https://login.persona.org/include.js.

Summary

The BrowserID protocol defines a new id property on the window.navigator object, through which it exposes the BrowserID API. This API has gone through several significant revisions. Each generation is listed separately below.

The "Observer" API (Current)

The Observer API introduces much-requested features, such as an improved post-verification experience for first-time users, automatic persistent logins, and easier integration with native applications.

navigator.id.watch()
Registers callbacks to be invoked when a user logs into or out of a website.
navigator.id.request()
Requests a signed identity assertion from the user.
navigator.id.logout()
Logs the user out of a website and prevents the onlogin action from automatically firing on their next visit.

Users with third-party cookies disabled may experience problems logging in using the Observer API as detailed in issue 2999.

The "Callback" API (Current)

The Callback API was introduced in November 2011. It improved upon the initial API by allowing options to be passed to navigator.id.get() and offering experimental support for BrowserID-managed persistent sessions.

navigator.id.get()
Gets the user's BrowserID in a signed assertion.

The "VerifiedEmail" API (Deprecated)

The VerifiedEmail API was BrowserID's first API. It was deprecated at the end of 2011.

navigator.id.getVerifiedEmail()
Gets the user's BrowserID in a signed assertion. This method is deprecated; navigator.id.get() is backwards compatible and can be used instead.

Document Tags and Contributors

 Last updated by: Sheppy,