Important

In alignment with our maintenance policy, the ForgeRock SDKs v4.x will enter maintenance mode on April 15, 2026, and reach end-of-support on April 15, 2028.

Existing applications that use ForgeRock SDKs v4.x will continue to function as intended. Between April 15, 2026, and end-of-support on April 15, 2028, the ForgeRock SDKs v4.x will only receive critical bug fixes and security updates. The SDK will not be updated to support new PingAM, Ping AIC, or PingOne services, new service features, or changes to existing services.

We recommend that you migrate to Ping Orchestration SDK v2.x. The new SDK provides improved features, enhanced performance, and continued support from Ping. By adopting the latest version of the SDK, developers can ensure the security, compatibility, and stability of their solutions. Migration guides are available in the new SDK repository.

The Ping SDk for iOS enables you to quickly integrate Ping products into your iOS apps.

Use the SDKs to leverage Intelligent Access to easily step through each stage of an authentication tree by using callbacks.

Requirements

• Ping Identity Platform
  • Ping Advanced Identity Cloud
  • PingAM 6.5.2+
• iOS 12 and above
• Xcode
• Swift 5.x
• CocoaPods or Swift Package Manager (optional)

Installation

Cocoapods

Use the following pods in your Podfile to install FR iOS SDK module(s) if you want to install the latest version.

pod 'FRAuth' // Authentication module
pod 'FRUI' // UI SDK demonstrates FRAuth SDK functionalities
pod 'FRProximity' // Add-on for FRAuth's Device Profile feature related to location, and BLE
pod 'FRAuthenticator' // Authenticator module that generates HOTP, TOTP, and Push registration/authentication
pod 'FRGoogleSignIn' // Social Login module for Google Sign In
pod 'FRFacebookSignIn' // Social Login module for Facebook Login
pod 'FRDeviceBinding' // Add-on for Device Binding feature
pod 'PingProtect' // Add-on for Ping Protect feature
pod 'FRCaptchaEnterprise' // Add-on for the ReCaptcha Enterprise feature

Swift Package Manager

• The ForgeRock iOS SDK is available via Swift Package Manager from 3.0.0 and above. Any older versions (2.2.0 and below) are only available via Cocoapods.
• FRGoogleSignIn module is currently not available in Swift Package Manager; use Cocoapods instead to integrate FRGoogleSignIn module.

1. In Xcode menus, File -> Swift Packages -> Add Package Dependencies...
2. Select the project to integrate the Ping SDK for iOS
3. Enter the url of the repo: https://github.com/ForgeRock/forgerock-ios-sdk
4. Select module(s) to integrate into the project

Getting Started

To try out the Ping SDK for iOS sample, perform these steps:

1. Setup your server as described in the documentation
2. Clone the sample apps repo:

   git clone https://github.com/ForgeRock/sdk-sample-apps
   

3. Open the iOS/swiftui-quickstart/Quickstart.xcodeproj file in Xcode.
4. Open /Quickstart/Resources/FRAuthConfig and edit the values to match your server.
5. Ensure the active scheme is "QuickStart", and then click the Run button.

Samples

We provide a sample repo to help demonstrate SDK functionality.

Documentation

Documentation for the SDKs is provided at https://docs.pingidentity.com/sdks, and includes topics such as:

• Introducing SDK features
• Preparing AM for use with the SDKS
• API Reference documentation

Support

If you encounter any issues, be sure to check our Troubleshooting pages.

Support tickets can be raised whenever you need our assistance; here are some examples of when it is appropriate to open a ticket (but not limited to):

• Suspected bugs or problems with ForgeRock software.
• Requests for assistance - please look at the Documentation and Knowledge Base first.

You can raise a ticket using the Ping Identity Support Portal that provides one stop access to support services.

The support portal shows all currently open support tickets and allows you to raise a new one by clicking New Ticket.

Contributing

If you would like to contribute to this project, please see the contributions guide.

Disclaimer

This code is provided by Ping Identity Corporation ("Ping") on an "as is" basis, without warranty of any kind, to the fullest extent permitted by law. Ping Identity Corporation does not represent or warrant or make any guarantee regarding the use of this code or the accuracy, timeliness or completeness of any data or information relating to this code, and Ping Identity Corporation hereby disclaims all warranties whether express, or implied or statutory, including without limitation the implied warranties of merchantability, fitness for a particular purpose, and any warranty of non-infringement. Ping Identity Corporation shall not have any liability arising out of or related to any use, implementation or configuration of this code, including but not limited to use for any commercial purpose. Any action or suit relating to the use of the code may be brought only in the courts of a jurisdiction wherein Ping Identity Corporation resides or in which Ping Identity Corporation conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions.

License

This project is licensed under the MIT License - see the LICENSE file for details

---

© Copyright 2020-2026 Ping Identity. All Rights Reserved.