Skip to content
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.

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

Update README.md to add content on TWA #682

Merged
merged 5 commits into from
Aug 2, 2023
Merged
Changes from 2 commits
Commits
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
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,36 @@ The callback will get invoked when the user returns to your application. There a

If the `returnTo` URL is not found in the **Allowed Logout URLs** of your Auth0 Application, the server will not make the redirection and the browser will remain open.

### Trusted Web Activity (Experimental Release)

> **⚠️ Warning:** Trusted Web Activity support in Auth0.Android is still experimental and can change in the future.
>
> Please test it thoroughly in all the targeted browsers and OS variants and let us know your feedback.

Trusted Web Activity is a feature provided by some browsers to provide a native look and feel.

<p align="center">
<img width="500" alt="Trusted Web Activity" src="https://github.com/auth0/Auth0.Android/assets/15910425/0be50959-e7e9-4a41-a99c-4c4c377e1faa">
</p>

To use this feature, there are some additional steps you must take:

- We need the SHA256 fingerprints of the app’s signing certificate. To get this, you can run the following command on your APK
poovamraj marked this conversation as resolved.
Show resolved Hide resolved
```shell
keytool -printcert -jarfile sample-debug.apk
```
- The fingerprint has to be updated in the [Auth0 Dashboard](https://manage.auth0.com/dashboard/eu/poovamraj/applications) under
Applications > *Specific Application* > Settings > Advanced Settings > Device Settings > Key Hashes
- App's package name has to be entered in the field above
poovamraj marked this conversation as resolved.
Show resolved Hide resolved

Once the above prerequisites are met, you can call your login method as below to open your web authentication in Trusted Web Activity.
poovamraj marked this conversation as resolved.
Show resolved Hide resolved

```kotlin
WebAuthProvider.login(account)
.withTrustedWebActivity()
.await(this)
```

## Credentials Manager

This library ships with two additional classes that help you manage the Credentials received during authentication.
Expand Down