Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

apple-auth

1.0.6 • Public • Published

 Sign in with Apple for Node.js

Follow @ananayarora

An easy-to-use Node.js library for Signing in with Apple!

Now with support for fetching the name and email!

⚠️ Important note: Apple will only provide you with the name and email ONCE which is when the user taps "Sign in with Apple" on your app the first time. Keep in mind that you have to store this in your database at this time! For every login after that, Apple will provide you with a unique ID that you can use to lookup the username in your database.

Check out the passport version of this library here:

https://github.com/ananay/passport-apple

https://npmjs.com/package/passport-apple

Setup

Begin by installing the library: npm install apple-auth

The configurations for Sign in with Apple are quite extensive so I've made an extensive SETUP.md file that you can read https://github.com/ananay/apple-auth/blob/master/SETUP.md

Example

I've created an example of how to use this library with Express! Check it out here:

https://github.com/ananay/apple-auth-example

Example live on https://apple.ananay.dev

Usage

Initialize it using the following code:

const fs = require('fs');
const AppleAuth = require('apple-auth');
const config = fs.readFileSync("./config/config");
const auth = new AppleAuth(config, './config/AuthKey.p8');

Methods:

  • auth.loginURL() - Creates the Login URL that your users will use to login to
  • auth.accessToken(grantCode) - Gets the access token from the grant code received
  • auth.refreshToken(refreshToken) - Gets the access token from a refresh token

Troubleshooting

invalid_grant when authorization code is generated by iOS App

Fix: If the authorizationCode was generated by your app, you should use your App ID as your clientId and not your service one. Discussion: https://github.com/ananay/apple-auth/issues/13

Questions / Contributing

Feel free to open issues and pull requests. If you would like to be one of the core creators of this library, please reach out to me at i@ananayarora.com or message me on twitter @ananayarora!

Created with ❤️ by Ananay Arora

Install

npm i apple-auth

DownloadsWeekly Downloads

3,753

Version

1.0.6

License

MIT

Unpacked Size

19 kB

Total Files

7

Last publish

Collaborators

  • avatar