Skip to content

SDKS-4619: Add Support and Disclaimer sections to README.md #173

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
spetrov merged 2 commits into from
Apr 9, 2026
Merged

SDKS-4619: Add Support and Disclaimer sections to README.md #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6863c1e
SDKS-4619: Add Support and Disclaimer sections to README.md
witrisna Mar 18, 2026
60fc0cc
Merge branch 'develop' into SDKS-4619-2
witrisna Apr 8, 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
0 CONTRIBUTING.md → CONTRIBUTION.md
View file
Open in desktop
File renamed without changes.
66 changes: 61 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,26 @@

[![Ping Identity](https://www.pingidentity.com/content/dam/picr/nav/Ping-Logo-2.svg)](https://github.com/ForgeRock/ping-android-sdk)

The Ping SDK for Android is designed for creating mobile native Apps that seamlessly integrate with the PingOne platform.
It offers a range of APIs for user authentication, user device management, and accessing resources secured by PingOne.
This SDK is support Browser, iOS and Android platforms.
The Ping SDK for Android is designed for creating mobile native Apps that seamlessly integrate with
the PingOne platform.
It offers a range of APIs for user authentication, user device management, and accessing resources
secured by PingOne.

Please visit our [ documentation ](https://docs.pingidentity.com/sdks/latest/sdks/index.html) site for more information.
# Documentation

- **Quick Starts** - Find specific setup instructions in the quick start guide for each SDK module.
Begin with
the [DaVinci](https://docs.pingidentity.com/sdks/latest/davinci/tutorials/android/index.html)
or [Journey](https://docs.pingidentity.com/sdks/latest/sdks/tutorials/android-quickstart/index.html)
guide, based on your chosen orchestration platform.
- **Sample Apps** - Visit our [sample apps](https://github.com/ForgeRock/sdk-sample-apps) repository
on GitHub for examples showcasing various use cases.
- **Official Docs** - Refer to our
main [documentation site](https://docs.pingidentity.com/sdks/latest/sdks/index.html) for
comprehensive information on the SDKs.

# Modules

ping
├── foundation # Foundation module
│ ├── android # Android common utilities
Expand Down Expand Up @@ -46,6 +59,49 @@ Please visit our [ documentation ](https://docs.pingidentity.com/sdks/latest/sdk
└── samples # Sample applications
└── pingsampleapp # Combined Ping sample app

# Support

If you encounter any issues, be sure to check our *
*[Troubleshooting](https://docs.pingidentity.com/sdks/latest/sdks/troubleshooting.html)** pages.

Comment on lines +64 to +66
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix malformed Markdown emphasis around support links.

Lines 64-66 and Lines 74-76 contain split * markers (* *[...) that can break rendering. While touching this, update “one stop access” to “one-stop access” (Line 75) for grammar.

✏️ Proposed doc fix 
-If you encounter any issues, be sure to check our *
-*[Troubleshooting](https://docs.pingidentity.com/sdks/latest/sdks/troubleshooting.html)** pages.
+If you encounter any issues, be sure to check our
+**[Troubleshooting](https://docs.pingidentity.com/sdks/latest/sdks/troubleshooting.html)** pages.

-You can raise a ticket using the *
-*[Ping Identity Support Portal](https://support.pingidentity.com/s/)** that provides one stop access
+You can raise a ticket using the
+**[Ping Identity Support Portal](https://support.pingidentity.com/s/)** that provides one-stop access
 to support services.

Also applies to: 74-76

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 64 - 66, Fix the malformed Markdown emphasis around
the support links by removing the stray split asterisks so the link text like
"Troubleshooting" is correctly wrapped (e.g., **[Troubleshooting](...)** or
*[Troubleshooting](...)*), and update the phrase "one stop access" to the
corrected hyphenated form "one-stop access"; locate occurrences by searching for
the link text "Troubleshooting" and the phrase "one stop access" in README and
correct the surrounding asterisks and wording accordingly.

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 Ping Identity software.
* Requests for assistance - please look at the **[Documentation](https://docs.pingidentity.com/sdks)
** and **[Knowledge Base](https://support.pingidentity.com/s/knowledge-base)** first.

You can raise a ticket using the *
*[Ping Identity Support Portal](https://support.pingidentity.com/s/)** 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](./CONTRIBUTION.md).

# 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](./LICENSE) file for details
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
4 changes: 3 additions & 1 deletion davinci/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,4 +363,6 @@ user?.let {
it.userinfo()
it.logout()
}
```
```

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
4 changes: 3 additions & 1 deletion external-idp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,4 +419,6 @@ By following these steps and including the native SDK dependencies, your applica
more streamlined and
user-friendly authentication experience when users choose to log in with Google or Facebook. The
Ping External IDP
library intelligently handles the integration with these native SDKs when they are present.
library intelligently handles the integration with these native SDKs when they are present.

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/browser/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,5 @@ customization allows you to override this behavior for specific use cases or bro
| Redirect Handling | Manual, error-prone | Automatic via intent filters | Automatic via intent filters |
| App Store Policy | May be restricted for auth flows | Fully compliant | Fully compliant |
| Recommended For | Embedded content, not auth | Secure authentication/authorization | Secure authentication/authorization (preferred) |

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/device/device-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,3 +655,5 @@ This software may be modified and distributed under the terms of the MIT license

Copyright (c) 2025 Ping Identity Corporation. All rights reserved.


© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
Comment on lines +658 to +659
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Consolidate duplicate copyright notices.

This file now contains two different copyright notices with different formats and year ranges:

  • Line 656: "Copyright (c) 2025 Ping Identity Corporation. All rights reserved."
  • Line 659: "© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved"

Consider removing one of these copyright notices or consolidating them into a single, consistent format.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@foundation/device/device-client/README.md` around lines 658 - 659, The
README.md contains two duplicate copyright notices with different formats
("Copyright (c) 2025 Ping Identity Corporation. All rights reserved." and "©
Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved"); remove one
of them and consolidate into a single, consistent notice (pick one preferred
format and year range, e.g., "© 2025-2026 Ping Identity Corporation. All Rights
Reserved") so only that unified string remains in the file.

4 changes: 3 additions & 1 deletion foundation/device/device-id/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,6 @@ val customId = CustomDeviceIdentifier.id
persistence and security properties.
- **Handle gracefully**: Be prepared to handle cases where the device identifier changes.
- **Combine with other factors**: For authentication purposes, combine device identifiers with other
factors like user credentials.
factors like user credentials.

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/device/device-profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,3 +577,5 @@ interface AndroidBuildProvider {
Provides testable access to Android Build properties.

---

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/device/device-root/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,3 +248,5 @@ suspend fun reportDeviceStatus() {
}
```


© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/migration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,3 +347,5 @@ step("Access system resources") {
6. **Test thoroughly**: Ensure migration steps work correctly in isolation and as part of the full migration

---

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/oidc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,5 @@ web.authorize(
...
}
```

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/orchestrate/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,5 @@ module(CustomHeader, priority = 5, mode = OverrideMode.APPEND) {
header("Accept-Language", "zh")
}
```

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions foundation/storage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,3 +192,5 @@ class Memory<T : @Serializable Any> : Storage<T> {
// Delegate the MemoryStorage to the Storage
inline fun <reified T : @Serializable Any> MemoryStorage(): Storage<T> = StorageDelegate(Memory())
```

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
4 changes: 3 additions & 1 deletion foundation/testrail/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,6 @@ This setup will automatically report the test results to TestRail based on the p

Running test with `./gradlew build` will also run the test but may eventually generate a lot of
reports, each VM instance will generate a report if `TESTRAIL_RUN_ID` is not set.
You may want to set the `TESTRAIL_RUN_ID` to avoid this.
You may want to set the `TESTRAIL_RUN_ID` to avoid this.

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
2 changes: 2 additions & 0 deletions journey/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,3 +461,5 @@ Callback below will be supported by other modules:
| SelectIdpCallback | External Identity provider selection. |
| IdpCallback | External Identity provider authentication. |


© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
3 changes: 3 additions & 0 deletions mfa/auth-migration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,3 +616,6 @@ Legacy Files: [Deleted via StorageClient] (backed up if backup callback was pro
This module is part of the Ping Identity SDK for Android and is subject to the MIT License. See the LICENSE file for details.

---


© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
4 changes: 3 additions & 1 deletion mfa/oath/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,4 +357,6 @@ The [`SharedPrefsOathStorage`](/mfa/oath/src/androidTest/kotlin/com/pingidentity
## License

Copyright (c) 2026 Ping Identity Corporation. All rights reserved.
This software may be modified and distributed under the terms of the MIT license. See the LICENSE file for details.
This software may be modified and distributed under the terms of the MIT license. See the LICENSE file for details.

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
Comment on lines +361 to +362
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Consolidate duplicate copyright notices.

This file now contains two different copyright notices:

  • Line 359: "Copyright (c) 2026 Ping Identity Corporation. All rights reserved."
  • Line 362: "© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved"

The different formats and year ranges (2026 vs. 2025-2026) create inconsistency. Consider consolidating these into a single copyright notice.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@mfa/oath/README.md` around lines 361 - 362, Consolidate the two inconsistent
copyright notices by keeping a single canonical notice and removing the
duplicate; specifically replace the occurrences of "Copyright (c) 2026 Ping
Identity Corporation. All rights reserved." and "© Copyright 2025-2026 Ping
Identity Corporation. All Rights Reserved" with one consistent line (choose the
preferred year range and capitalization/format, e.g., "© 2025-2026 Ping Identity
Corporation. All Rights Reserved") and ensure the README.md contains only that
single, consistently formatted copyright statement.

2 changes: 2 additions & 0 deletions recaptcha-enterprise/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -900,3 +900,5 @@ If you continue to experience issues:

This software may be modified and distributed under the terms of the MIT license. See the LICENSE file for details.


© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
4 changes: 3 additions & 1 deletion samples/authenticatorapp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,4 +270,6 @@ Contributions are welcome! Please read the [contributing guidelines](../../CONTR
## License

Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
This software may be modified and distributed under the terms of the MIT license. See the [LICENSE](../LICENSE) file for details.
This software may be modified and distributed under the terms of the MIT license. See the [LICENSE](../LICENSE) file for details.

© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
Comment on lines +274 to +275
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Consolidate duplicate copyright notices.

This file now contains two different copyright notices:

  • Line 272: "Copyright (c) 2025 Ping Identity Corporation. All rights reserved."
  • Line 275: "© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved"

The different formats and year ranges create inconsistency. Consider consolidating these into a single copyright notice with a consistent format.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@samples/authenticatorapp/README.md` around lines 274 - 275, Consolidate the
two inconsistent copyright notices by removing one and standardizing the
remaining one to a single, consistent format; specifically, replace the
duplicate lines containing "Copyright (c) 2025 Ping Identity Corporation. All
rights reserved." and "© Copyright 2025-2026 Ping Identity Corporation. All
Rights Reserved" with a single unified notice (choose the preferred wording and
year range) so only one copyright string remains in README.md.

2 changes: 2 additions & 0 deletions samples/pingsampleapp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,3 +298,5 @@ For issues, questions, or contributions, please refer to the main Ping Android S

This sample application is licensed under the MIT License. See LICENSE file for details.


© Copyright 2025-2026 Ping Identity Corporation. All Rights Reserved
Loading