Sign in with Passport
Overview
Sign in with Passport makes it easy for users to sign in to your apps and websites using their Passport ID.
Instead of filling out forms, verifying email addresses, and choosing new passwords, they can use Sign in with Passport to set up an account and start using your app right away.
All accounts are protected with two-factor authentication for superior security, and Passport will not track users’ activity in your app or website.
Use Sign In with Passport to:
Reduce friction and obtain more sign-ups by allowing members to Sign In with Passport, without having the need to create a new account.
Minimize the costs and time associated with implementing your own login, identity, profile management, and password management.
Getting Started
Authenticating Members
New members logging in to your service for the first time will need to follow the Authenticating with OAuth 2.0 Guide. When requesting an authorization code in Step 2 of the OAuth 2.0 Guide, make sure to request the identity.profile and/or identity.email scopes!
identity.basic
Required to retrieve the member's lite profile including their id, name, and profile picture.
identity.profile
Required to retrieve the member's complete public profile data.
identity.email
Required to retrieve the member's email addresses.
organizations.memberships
Required to retrieve the member's organizations.
After successful authentication, you will acquire an access token that can be used in the next step of the sign-in process.
If your application does not have these permissions, you can add them through the Developer Portal.
Retrieving Member Profiles
With your newly acquired access token for the authenticated member, you can use the following API request to retrieve the member's profile information.
Sample Request
Request Body
token
string
Required. The string value of the token returned using Client Credential Flow or Authorization Code Flow
Sample Response
Retrieving Member Email Addresses
In addition to the member's profile, you may be interested in retrieving the member's email address. The identity.email permission scope allows usage of the following API:
Sample Request
Request Body
token
string
Required. The string value of the token returned using Client Credential Flow or Authorization Code Flow
Sample Response
Retrieving Member complete Profile
Use the API request below to retrieve the member's complete public profile. The identity.profile permission scope is required to use following API:
Sample Request
Request Body
token
string
Required. The string value of the token returned using Client Credential Flow or Authorization Code Flow
Sample Response
Retrieving Member Organizations
In addition to the member's profile, you may be interested in retrieving the member's organizations. The organizations.memberships permission scope allows usage of the following API:
Sample Request
Request Body
token
string
Required. The string value of the token returned using Client Credential Flow or Authorization Code Flow
Sample Response
Additional resources
Image resources
Last updated