# mgPass

## Docs

- [Get Own Profile](https://docs.mgpass.net/api-reference/account/get-profile.md)
- [List Linked Social Accounts](https://docs.mgpass.net/api-reference/account/list-identities.md)
- [List Own Sessions](https://docs.mgpass.net/api-reference/account/list-sessions.md)
- [Revoke Own Session](https://docs.mgpass.net/api-reference/account/revoke-session.md)
- [Update Own Profile](https://docs.mgpass.net/api-reference/account/update-profile.md)
- [Create Benefit](https://docs.mgpass.net/api-reference/admin-benefits/create-benefit.md)
- [Delete Benefit](https://docs.mgpass.net/api-reference/admin-benefits/delete-benefit.md)
- [Get Benefit](https://docs.mgpass.net/api-reference/admin-benefits/get-benefit.md)
- [List Benefits](https://docs.mgpass.net/api-reference/admin-benefits/list-benefits.md)
- [Update Benefit](https://docs.mgpass.net/api-reference/admin-benefits/update-benefit.md)
- [Export CSV](https://docs.mgpass.net/api-reference/admin-ledger/export-csv.md)
- [Manual Credit](https://docs.mgpass.net/api-reference/admin-ledger/manual-credit.md)
- [Reconcile Balance](https://docs.mgpass.net/api-reference/admin-ledger/reconcile.md)
- [Search Ledger](https://docs.mgpass.net/api-reference/admin-ledger/search-ledger.md)
- [Create Partner](https://docs.mgpass.net/api-reference/admin-partners/create-partner.md)
- [List Partners](https://docs.mgpass.net/api-reference/admin-partners/list-partners.md)
- [Rotate API Key](https://docs.mgpass.net/api-reference/admin-partners/rotate-key.md)
- [Approve or Reject](https://docs.mgpass.net/api-reference/admin-redemptions/approve-reject.md)
- [List Redemptions](https://docs.mgpass.net/api-reference/admin-redemptions/list-redemptions.md)
- [Create Rule](https://docs.mgpass.net/api-reference/admin-rules/create-rule.md)
- [Delete Rule](https://docs.mgpass.net/api-reference/admin-rules/delete-rule.md)
- [Get Rule](https://docs.mgpass.net/api-reference/admin-rules/get-rule.md)
- [List Event Types](https://docs.mgpass.net/api-reference/admin-rules/list-event-types.md)
- [List Rules](https://docs.mgpass.net/api-reference/admin-rules/list-rules.md)
- [Update Rule](https://docs.mgpass.net/api-reference/admin-rules/update-rule.md)
- [Get Template](https://docs.mgpass.net/api-reference/admin-templates/get-template.md)
- [List Templates](https://docs.mgpass.net/api-reference/admin-templates/list-templates.md)
- [Update Template](https://docs.mgpass.net/api-reference/admin-templates/update-template.md)
- [Add Scope to Resource](https://docs.mgpass.net/api-reference/api-resources/add-scope.md)
- [Create API Resource](https://docs.mgpass.net/api-reference/api-resources/create-resource.md)
- [Get API Resource](https://docs.mgpass.net/api-reference/api-resources/get-resource.md)
- [List API Resources](https://docs.mgpass.net/api-reference/api-resources/list-resources.md)
- [Create OAuth Client](https://docs.mgpass.net/api-reference/applications/create-client.md)
- [Delete OAuth Client](https://docs.mgpass.net/api-reference/applications/delete-client.md)
- [Get OAuth Client](https://docs.mgpass.net/api-reference/applications/get-client.md)
- [List OAuth Clients](https://docs.mgpass.net/api-reference/applications/list-clients.md)
- [Rotate Client Secret](https://docs.mgpass.net/api-reference/applications/rotate-secret.md)
- [Update OAuth Client](https://docs.mgpass.net/api-reference/applications/update-client.md)
- [List Audit Logs](https://docs.mgpass.net/api-reference/audit/list-audit-logs.md)
- [FedCM Accounts List](https://docs.mgpass.net/api-reference/authentication/fedcm-accounts.md): Returns logged-in user accounts. Called by the browser with first-party cookies and Sec-Fetch-Dest webidentity header.
- [FedCM Token Assertion](https://docs.mgpass.net/api-reference/authentication/fedcm-assertion.md): Issues a JWT token for the selected account. Called by the browser after the user consents to sharing their identity.
- [FedCM Client Metadata](https://docs.mgpass.net/api-reference/authentication/fedcm-client-metadata.md): Returns the privacy policy and terms of service URLs for the requesting client.
- [FedCM IdP Configuration](https://docs.mgpass.net/api-reference/authentication/fedcm-config.md): Returns the FedCM identity provider configuration including endpoint URLs and branding information.
- [FedCM Provider Discovery](https://docs.mgpass.net/api-reference/authentication/fedcm-discovery.md): Returns the list of FedCM provider config URLs. Called by the browser to discover FedCM-capable identity providers.
- [JSON Web Key Set](https://docs.mgpass.net/api-reference/authentication/jwks.md)
- [RP-Initiated Logout](https://docs.mgpass.net/api-reference/authentication/logout.md)
- [OIDC Discovery](https://docs.mgpass.net/api-reference/authentication/oidc-discovery.md)
- [One Tap Session Check (iframe)](https://docs.mgpass.net/api-reference/authentication/onetap-check.md): Returns an HTML page that checks for the mgpass_session cookie and posts user info to the parent window via postMessage. Used internally by the One Tap SDK.
- [One Tap JavaScript SDK](https://docs.mgpass.net/api-reference/authentication/onetap-sdk.md): Self-contained JavaScript SDK for cross-domain SSO. Embed via script tag on any partner site.
- [One Tap Session Check (JSON)](https://docs.mgpass.net/api-reference/authentication/onetap-session.md): Returns current session status and basic user info. Requires cookies (same-origin or CORS with credentials).
- [Token Exchange](https://docs.mgpass.net/api-reference/authentication/token-exchange.md)
- [Payment Callback](https://docs.mgpass.net/api-reference/cashback/callback.md)
- [Redeem Cashback](https://docs.mgpass.net/api-reference/cashback/redeem-cashback.md)
- [API Reference](https://docs.mgpass.net/api-reference/introduction.md): Complete reference for the mgPass Rewards API endpoints.
- [Add Organization Member](https://docs.mgpass.net/api-reference/organizations/add-member.md)
- [Create Organization](https://docs.mgpass.net/api-reference/organizations/create-org.md)
- [Get Organization](https://docs.mgpass.net/api-reference/organizations/get-org.md)
- [List Organizations](https://docs.mgpass.net/api-reference/organizations/list-orgs.md)
- [Publish Event](https://docs.mgpass.net/api-reference/partner-events/publish-event.md)
- [Assign Role to User](https://docs.mgpass.net/api-reference/roles/assign-role.md)
- [Create Role](https://docs.mgpass.net/api-reference/roles/create-role.md)
- [Delete Role](https://docs.mgpass.net/api-reference/roles/delete-role.md)
- [Get Role](https://docs.mgpass.net/api-reference/roles/get-role.md)
- [List Roles](https://docs.mgpass.net/api-reference/roles/list-roles.md)
- [Remove Role from User](https://docs.mgpass.net/api-reference/roles/remove-role.md)
- [Update Role](https://docs.mgpass.net/api-reference/roles/update-role.md)
- [Create User](https://docs.mgpass.net/api-reference/user-management/create-user.md)
- [Delete User](https://docs.mgpass.net/api-reference/user-management/delete-user.md)
- [Get User](https://docs.mgpass.net/api-reference/user-management/get-user.md)
- [List Social Identities](https://docs.mgpass.net/api-reference/user-management/list-identities.md)
- [List User Sessions](https://docs.mgpass.net/api-reference/user-management/list-user-sessions.md)
- [List Users](https://docs.mgpass.net/api-reference/user-management/list-users.md)
- [Login History](https://docs.mgpass.net/api-reference/user-management/login-history.md)
- [Revoke All Sessions](https://docs.mgpass.net/api-reference/user-management/revoke-all-sessions.md)
- [Suspend User](https://docs.mgpass.net/api-reference/user-management/suspend-user.md)
- [Unsuspend User](https://docs.mgpass.net/api-reference/user-management/unsuspend-user.md)
- [Update User](https://docs.mgpass.net/api-reference/user-management/update-user.md)
- [Get Balance & Tier](https://docs.mgpass.net/api-reference/user-rewards/get-balance.md)
- [Get Points History](https://docs.mgpass.net/api-reference/user-rewards/get-history.md)
- [Get Redemptions](https://docs.mgpass.net/api-reference/user-rewards/get-redemptions.md)
- [Redeem Catalog Item](https://docs.mgpass.net/api-reference/user-rewards/redeem-catalog-item.md)
- [Applications (OAuth Clients)](https://docs.mgpass.net/guides/applications.md): Register and configure OAuth clients for authentication with mgPass.
- [Audit Logs](https://docs.mgpass.net/guides/audit-logs.md): Query and understand audit logs for compliance and security monitoring in mgPass.
- [Authentication](https://docs.mgpass.net/guides/authentication.md): How to authenticate with the mgPass Rewards API.
- [Awarding Points](https://docs.mgpass.net/guides/awarding-points.md): How points are calculated, capped, and credited to users.
- [Cashback](https://docs.mgpass.net/guides/cashback.md): Converting points to mobile money via MTN, Telecel, or AirtelTigo.
- [Catalog Redemption](https://docs.mgpass.net/guides/catalog-redemption.md): How users browse and redeem rewards from the catalog.
- [Error Handling](https://docs.mgpass.net/guides/error-handling.md): How to handle API errors, rate limits, and edge cases.
- [Introduction](https://docs.mgpass.net/guides/introduction.md): The mgPass Rewards API powers the loyalty and points ecosystem across MG Digital platforms.
- [Multi-Factor Authentication](https://docs.mgpass.net/guides/mfa.md): Configure and enforce MFA with TOTP and recovery codes in mgPass.
- [Migrating from Logto](https://docs.mgpass.net/guides/migration.md): Guide for migrating users, sessions, and rewards data from Logto to mgPass.
- [OAuth 2.0 / OIDC Flows](https://docs.mgpass.net/guides/oauth-flows.md): Complete guide to implementing OAuth 2.0 and OpenID Connect authentication with mgPass.
- [FedCM Integration](https://docs.mgpass.net/guides/onetap-sdk.md): Integrate cross-domain single sign-on using FedCM (Federated Credential Management) -- the browser-native identity federation API. No iframes, no third-party cookies.
- [Organizations](https://docs.mgpass.net/guides/organizations.md): Multi-tenancy with organizations in mgPass for partner companies and enterprise clients.
- [What is mgPass?](https://docs.mgpass.net/guides/overview.md): An overview of the mgPass identity platform — architecture, services, and core concepts.
- [Partner Integration](https://docs.mgpass.net/guides/partner-integration.md): Complete guide for external partners integrating with mgPass Rewards.
- [Quickstart](https://docs.mgpass.net/guides/quickstart.md): Publish your first event and award points in under 5 minutes.
- [Roles, Scopes & Permissions](https://docs.mgpass.net/guides/rbac.md): Configure role-based access control (RBAC) to manage what users and applications can do.
- [Sessions and Tokens](https://docs.mgpass.net/guides/sessions-tokens.md): How mgPass manages sessions, issues tokens, and handles token lifecycle.
- [SMS OTP Verification](https://docs.mgpass.net/guides/sms-otp.md): Configure and use SMS one-time passwords via Hubtel for user verification in mgPass.
- [Social Login](https://docs.mgpass.net/guides/social-login.md): Configure Google, Apple, and Facebook social connectors for mgPass authentication.
- [Single Sign-On (SSO)](https://docs.mgpass.net/guides/sso.md): How mgPass provides seamless single sign-on across all connected properties and partner applications.
- [Tiers & Benefits](https://docs.mgpass.net/guides/tiers-and-benefits.md): Understanding the tier system and how users progress.
- [Token Refresh](https://docs.mgpass.net/guides/token-refresh.md): How to keep users authenticated with automatic token renewal, refresh token rotation, and silent auth fallback.
- [User Management](https://docs.mgpass.net/guides/user-management.md): Create, update, search, and manage users via the mgPass API.
- [Webhooks](https://docs.mgpass.net/guides/webhooks.md): Receive real-time notifications when rewards events occur.
- [Identity Webhooks](https://docs.mgpass.net/guides/webhooks-identity.md): Subscribe to identity lifecycle events — logins, registrations, suspensions, and more.
- [mgPass Identity Platform](https://docs.mgpass.net/index.md): Developer documentation for mgPass — the identity, authentication, and rewards platform.

## OpenAPI Specs

- [openapi](https://docs.mgpass.net/openapi.yaml)