Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ananay/apple-auth
Sign in with Apple for Node.js
https://github.com/ananay/apple-auth
Last synced: 11 days ago
JSON representation
Sign in with Apple for Node.js
- Host: GitHub
- URL: https://github.com/ananay/apple-auth
- Owner: ananay
- Created: 2019-06-05T17:57:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T23:28:13.000Z (8 months ago)
- Last Synced: 2024-10-31T22:06:15.326Z (13 days ago)
- Language: JavaScript
- Homepage:
- Size: 113 KB
- Stars: 326
- Watchers: 7
- Forks: 59
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sign in with Apple for Node.js
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 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 and the email 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 [email protected] or message me on twitter @ananayarora!
Created with ❤️ by Ananay Arora
#### ⚠️ Disclaimer
This repository is NOT developed, endorsed by Apple Inc. or even related at all to Apple Inc. This library was implemented solely by the community's hardwork, and based on information that is public on Apple Developer's website. The library is a helper library for anyone trying to implement Apple's Sign in with Apple.