In this guide, we will show you how to set up Account Linking for your Amazon Alexa Skill, without having to deal with all the security issues and the burden of running your own OAuth 2.0 server. We will do this by using Auth0, a service for developers to authorize and authenticate users, which is a helpful tool for Alexa Account Linking.
- How OAuth2 Works
- What is Auth0?
- Alexa Account Linking: Connecting your Skill with Auth0
👉 Just interested in a user's email address? Take a look at Login with Amazon.
👉 Interested in Google Assistant Account Linking? How to set up Account Linking for Google Actions with Auth0 and Jovo.
One way to make your voice application stand out from the other Skills is by using Account Linking. It allows you to get to know your users and lets you personalize the experience with user specific data. For example, you could do things like this:
- Greet your users with their name every time they start your voice application
- Get access to an email address to provide a user with additional information via email
- Create multimodal experiences by connecting a voice experience with e.g. a web service, Messenger chatbot, or other accounts
Amazon requires the OAuth 2.0 protocol for Account Linking. You can find the official documentation by Amazon here: Link an Alexa User with a User in Your System. As a developer you have two options to implement Account Linking for your Skill:
- You set up your own OAuth 2.0 server, or
- You use one of the many identity providers (Google, Facebook, Twitter, etc.) out there
First of all, setting up an OAuth 2.0 server can be difficult (at least, I had a tough time), and using a single identity provider restricts your user. Not everybody has a Facebook account. A service like Auth0 comes in handy in such a situation. It allows us to use the many identity providers and the standard username-password login at the same time.
In this post, we're first learning more about OAuth2 in general, and then walk through setting up a simple example of Alexa Account Linking with Auth0, step by step.
OAuth 2.0 is an authorization protocol which allows third-party applications to gain limited access to an HTTP service. It enables the user to provide access to restricted resources, without giving away their credentials (username and password).
The protocol defines the following four roles:
- Resource Owner: In our case the user, who wants to link their account with your Alexa Skill.
- Resource Server: The server, where our user's data is located at. Has to be able to respond to resource requests using access tokens.
- Client: The application, which wants to access the user's account. In this case it's Alexa.
- Authorization Server: The server that authenticates the identity of the resource owner and provides the access token.
Here's how the roles interact with each other:
Auth0 provides a service for developers to authorize and authenticate users without having to deal with all the security issues and the burden of running your own OAuth 2.0 server. Here are some of the tools Auth0 provides:
- User Management that supports both standard username + password logins and social logins like Google, Facebook, etc.
- Auth0 Lock, a login box
- Passwordless Logins
Usually, such a service is not free, but Auth0 offers a free tier for up to 7,000 regular active users/month. They count a regular active user as someone who has ‘authenticated with username/password, passwordless connections or any social provider in the last calendar month, counted per application’.
In the following steps, we are going to use both username + password and social login features by Auth0 to create an Account Linking process for our Alexa Skill.
There are three steps needed to connect your Alexa Skill with Auth0.
- Set up an Auth0 application and the providers we want to use for social login
- Fill out the Account Linking form on the Amazon Alexa Developer platform 3. Add the code, so we can prompt our users to link their account with our Skill.
In this section, we're going through all the necessary steps you need to create an application on Auth0 and to pick identity providers for your social login. First of all you have to create an account on Auth0.
To create an application click on the orange button on the top right corner of the dashboard:
Name your application and select 'Machine to Machine Applications':
Choose the Auth0 Management API and select all scopes. Going over all the scopes would be to much for this blogpost.
The result should be a dashboard like this:
Switch to the Settings tab and change the Token Endpoint Authentication Method to Basic.
At the bottom of the settings tab click on Show Advances Settings and switch to OAuth. Select HS256 on JsonWebToken Signature Algorithm and save your changes.
The next step is to enable the social logins you want to use. You can find them in Connections > Social:
Here is an overview of connections you can choose from:
Choose the provider you want to enable and the data you want to access. There is guide on how to set up every provider. It's marked on the screenshot:
If you don't already have on, go to the Amazon Developer Platform, create an Alexa Skill and open the Account Linking tab:
Below, you can find a list of all the information needed for Account Linking, and where to get it from:
- Authorization URL: Auth0 Client we created earlier → Settings → Advanced Settings → Endpoints → OAuth Authorization URL
- Client ID: Auth0 Client we created earlier → Settings → Client ID
- Domain List: cdn.auth0.com
- Scope: openid, offline_access, profile, email
- Authorization Grant Type: Auth Code Grant
- Access Token URI: Auth0 Client we created earlier → Settings → Advanced Settings → Endpoints → OAuth Token URL
- Client Secret: Auth0 Client we created earlier → Settings → Client Secret
The scopes we use indicate the level of access we want on the user's data:
- openid allows us to use the API request we need later on, to access the stored user data.
- _offlineaccess is needed because the access token we get will expire at some point. To request a new one, without having to re-authenticate the user, we need that scope.
- profile (basic data like name and birthdate) and email are used to tell the server what kind of data we want.
This is how it looks like when it's filled out:
Now before you close both tabs, we have to add the Redirect URLs provided by Amazon (see in the above screenshot) to our Auth0 Client. On your Client's Settings tab, there is the Allowed Callback URLs field. Add the Redirect URLs to that field and separate them with a comma.
👉 Just getting started with Alexa Skill development? Take a look here: Build an Alexa Skill in Node.js with Jovo.
You're pretty much at the end of this tutorial. The last thing we want to show you is a code example, which should give you an idea how to implement Account Linking in your own code.
This will display an Account linking card in the Alexa companion app or the Alexa website. By clicking on Link Account the user will be redirected to your own Auth0 login page.
That's how the Auth0 login page looks like:
To access the stored user data, you simply make an API request, using the access token your skill gets with every request made after the user linked his account. Since the API request is asynchronous, we have to await the response, before the framework sends out the response at the end of the intent. I recommend the
request-promise package for that, since it is the simplest solution. You can install it with npm:
After that import it in your
Now let's get to the request:
At the end your code should look like this:
That's it, you made it!