README.md

Capacitor Sign in With Apple

Capacitor plugin to support Sign in With Apple

🚨 This plugin is for Capacitor 6 🚨

Capacitor 5 users can use version 5.x

Capacitor 4 users can use version 4.x

Capacitor 3 users can use version 1.x

Capacitor 2 users can use version 0.2.0

Maintainers

Maintainer	GitHub	Social	Sponsoring Company
Max Lynch	mlynch	@maxlynch	Ionic
Jose "Pilito" Martinez	epicshaggy	@pilito_he
Laszlo Csoka	lcsoka

Maintenance Status: Partially Maintained (help wanted)

Installation

• npm i @capacitor-community/apple-sign-in
• npx cap update

Usage (iOS, Web)

import {
  SignInWithApple,
  SignInWithAppleResponse,
  SignInWithAppleOptions,
} from '@capacitor-community/apple-sign-in';

let options: SignInWithAppleOptions = {
  clientId: 'com.your.webservice',
  redirectURI: 'https://www.yourfrontend.com/login',
  scopes: 'email name',
  state: '12345',
  nonce: 'nonce',
};

SignInWithApple.authorize(options)
  .then((result: SignInWithAppleResponse) => {
    // Handle user information
    // Validate token with server and create new session
  })
  .catch(error => {
    // Handle error
  });

Instructions (Android)

Not supported.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Masahiko Sakakibara 💻

Pilito 💻

lcsoka 💻

This project follows the all-contributors specification. Contributions of any kind welcome!