|
6 | 6 | - [Specify scope](#specify-scope) |
7 | 7 | - [Specify Connection scope](#specify-connection-scope) |
8 | 8 | - [Specify Parameter](#specify-parameter) |
| 9 | + - [Specify a Custom Authorize URL](#specify-a-custom-authorize-url) |
9 | 10 | - [Customize the Custom Tabs UI](#customize-the-custom-tabs-ui) |
10 | 11 | - [Changing the Return To URL scheme](#changing-the-return-to-url-scheme) |
| 12 | + - [Specify a Custom Logout URL](#specify-a-custom-logout-url) |
11 | 13 | - [Trusted Web Activity](#trusted-web-activity) |
12 | 14 | - [Authentication API](#authentication-api) |
13 | 15 | - [Login with database connection](#login-with-database-connection) |
@@ -95,6 +97,28 @@ WebAuthProvider.login(account) |
95 | 97 | .start(this, callback) |
96 | 98 | ``` |
97 | 99 |
|
| 100 | +## Specify a Custom Authorize URL |
| 101 | + |
| 102 | +In scenarios where you need to use a specific authorize endpoint different from the one derived from your Auth0 domain (e.g., for custom domains, specific tenant configurations), you can provide a full custom URL to the `/authorize` endpoint. |
| 103 | + |
| 104 | +```kotlin |
| 105 | +WebAuthProvider.login(account) |
| 106 | +.withAuthorizeUrl("https://YOUR_CUSTOM_TENANT_OR_AUTH_DOMAIN/authorize") |
| 107 | +.start(this, callback) |
| 108 | +``` |
| 109 | + |
| 110 | +<details> |
| 111 | + <summary>Using Java</summary> |
| 112 | + |
| 113 | +```java |
| 114 | +WebAuthProvider.login(account) |
| 115 | +.withAuthorizeUrl("https://YOUR_CUSTOM_TENANT_OR_AUTH_DOMAIN/authorize") |
| 116 | +.start(this, callback); |
| 117 | +``` |
| 118 | +</details> |
| 119 | + |
| 120 | +The URL provided to `.withAuthorizeUrl()` must be a complete and valid HTTPS URL for an OAuth 2.0 authorize endpoint. The SDK will append standard OAuth parameters to this custom base URL. |
| 121 | + |
98 | 122 | ## Customize the Custom Tabs UI |
99 | 123 |
|
100 | 124 | If the device where the app is running has a Custom Tabs compatible Browser, a Custom Tab will be preferred for the logout flow. You can customize the Page Title visibility, the Toolbar color, and the supported Browser applications by using the `CustomTabsOptions` class. |
@@ -134,6 +158,27 @@ WebAuthProvider.logout(account) |
134 | 158 | .start(this, logoutCallback) |
135 | 159 | ``` |
136 | 160 |
|
| 161 | +## Specify a Custom Logout URL |
| 162 | + |
| 163 | +Similar to the authorize URL, you can specify a custom logout endpoint if your setup requires it (e.g., using custom domains or for specific logout behaviors configured in your Auth0 tenant). |
| 164 | + |
| 165 | +```kotlin |
| 166 | +WebAuthProvider.logout(account) |
| 167 | +.withLogoutUrl("https://YOUR_CUSTOM_TENANT_OR_AUTH_DOMAIN/v2/logout") |
| 168 | +.start(this, logoutCallback) |
| 169 | +``` |
| 170 | +<details> |
| 171 | + <summary>Using Java</summary> |
| 172 | + |
| 173 | +```java |
| 174 | +WebAuthProvider.logout(account) |
| 175 | + .withLogoutUrl("https://YOUR_CUSTOM_TENANT_OR_AUTH_DOMAIN/v2/logout") |
| 176 | + .start(this, logoutCallback); |
| 177 | +``` |
| 178 | +</details> |
| 179 | + |
| 180 | +The URL provided to `.withLogoutUrl()` must be a complete and valid HTTPS URL for logout endpoint. The SDK will append standard logout parameters to this custom base URL. |
| 181 | + |
137 | 182 | ## Trusted Web Activity |
138 | 183 |
|
139 | 184 | Trusted Web Activity is a feature provided by some browsers to provide a native look and feel to the custom tabs. |
@@ -1515,4 +1560,4 @@ The rules should be applied automatically if your application is using `minifyEn |
1515 | 1560 | By default you should at least use the following files: |
1516 | 1561 | * `proguard-okio.pro` |
1517 | 1562 | * `proguard-gson.pro` |
1518 | | -* `proguard-jetpack.pro` |
| 1563 | +* `proguard-jetpack.pro` |
0 commit comments