Authentication

Complete Configuration before using the authentication methods.

Platform behavior

The tracking login option is iOS-only and defaults to limited. In Limited Login, iOS returns an OIDC authentication token (JWT), not a Graph API access token. The plugin does not currently return the Graph access token obtained with tracking: 'enabled'.

The nonce option is used by Android and iOS and ignored on Web. Pass the raw nonce; the native implementations hash it before giving it to the Facebook SDK.

Login

Request only the permissions your app uses. Call login from a user action such as a button click:

import { FacebookLogin } from '@capacitor-community/facebook-login';

const result = await FacebookLogin.login({
  permissions: ['email'],
});

if (result.accessToken) {
  console.log('Facebook login succeeded.');
} else {
  // Cancelled or no token returned by the native platform.
  console.log('Facebook login canceled or returned no token.');
}

Do not log accessToken.token. On Web, login rejects if Facebook does not return a usable token. On Android and iOS, a cancelled login resolves without a token.

iOS tracking mode and nonce

const result = await FacebookLogin.login({
  permissions: ['email'],
  tracking: 'limited',
  nonce: crypto.randomUUID(),
});

Limited Login tokens should be validated as OIDC tokens by your backend. Do not treat them as Graph API access tokens.

Current token

const result = await FacebookLogin.getCurrentAccessToken();

if (result.accessToken) {
  console.log('Current Facebook token is available.', {
    isExpired: result.accessToken.isExpired,
    permissions: result.accessToken.permissions,
  });
}

Native platforms resolve without a token when logged out. Web rejects when there is no connected Facebook session.

Profile fields

const profile = await FacebookLogin.getProfile<{
  id: string;
  email?: string;
}>({ fields: ['id', 'email'] });

The fields must be permitted for your Meta app and granted by the user. The returned object contains only fields returned by the Graph API. On iOS, this requires a Graph access token and does not work with the default Limited Login token.

Reauthorize data access

Reauthorization is available on Android and iOS only.

const result = await FacebookLogin.reauthorize();

if (result.accessToken) {
  console.log('Data access was renewed.');
}

Logout

await FacebookLogin.logout();

Logging out clears the Facebook session managed by the platform SDK.