Skip to content

docs: add Entitlements & Admin Portal to README #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dianaKhortiuk-frontegg merged 2 commits into from
Jun 25, 2026
Merged

docs: add Entitlements & Admin Portal to README #81

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08a7cd3
docs: add Entitlements & Admin Portal to README; dedupe Native SDK ve…
dianaKhortiuk-frontegg Jun 25, 2026
d96cf81
docs: fix 'scenarIonic' typo in README
dianaKhortiuk-frontegg Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,20 @@ This repository includes:
- A [Get Started](https://ionic-capacitor-guide.frontegg.com/#/getting-started) guide for quick integration
- A [Setup Guide](https://ionic-capacitor-guide.frontegg.com/#/setup) with detailed setup instructions
- [Usage Examples](https://ionic-capacitor-guide.frontegg.com/#/usage) with common implementation patterns
- [Advanced Topics](https://ionic-capacitor-guide.frontegg.com/#/advanced) for complex integration scenarIonic
- [Advanced Topics](https://ionic-capacitor-guide.frontegg.com/#/advanced) for complex integration scenarios
- A [Embedded](https://github.com/frontegg/frontegg-ionic-capacitor/tree/master/example) example projects to help you get started quickly

For full documentation, visit the Frontegg Developer Portal:
🔗 [https://developers.frontegg.com](https://developers.frontegg.com)

---

## 🔐 Native SDK versions

The Ionic Capacitor wrapper depends on the underlying native SDKs:
## 🧩 Entitlements & Admin Portal

- On **Android**, the plugin and example app use `com.frontegg.sdk:android:1.3.34`.
- On **iOS**, the plugin depends on `FronteggSwift` **1.3.10** via CocoaPods.
The wrapper bridges two native capabilities into your Ionic app:

After upgrading, run `pod install` in your iOS project and rebuild both platforms.
- **Entitlements** — gate features and permissions on-device with `loadEntitlements()`, `getFeatureEntitlement({ key })`, and `getPermissionEntitlement({ key })` (each resolves to `{ isEntitled, justification }`). See the [Entitlements guide](https://github.com/frontegg/frontegg-ionic-capacitor/blob/master/docs/usage.md#entitlements).
- **Admin Portal** — open the embedded Frontegg Admin Portal for authenticated users with `openAdminPortal()`. It opens through the native iOS/Android token bridge, so users aren't prompted to log in again. See the [Admin Portal guide](https://github.com/frontegg/frontegg-ionic-capacitor/blob/master/docs/advanced.md#admin-portal-beta).

---

Expand Down
Loading