Skip to content

Commit dd27664

Browse files
AyushBherwani1998AyushBherwani1998
committed
update docs for react-native
1 parent b879e84 commit dd27664

4 files changed

Lines changed: 74 additions & 234 deletions

File tree

‎docs/sdk/pnp/react-native/custom-authentication.mdx‎

Lines changed: 38 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ First, configure your own verifier in the Web3Auth Dashboard to use custom authe
1717

1818
:::note
1919

20-
This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to use this SDK in a production environment is the
21-
**Growth Plan**. You can use this feature in the development environment for free.
20+
This is a paid feature and the minimum [pricing plan](https://web3auth.io/pricing.html) to use this SDK in a production environment is the **Growth
21+
Plan**. You can use this feature in the development environment for free.
2222

2323
:::
2424

@@ -52,22 +52,22 @@ Then, you should specify the details of your verifier in the value of the `Login
5252

5353
<TabItem value="table">
5454

55-
| Parameter | Type | Mandatory | Description |
56-
| ----------------------- | ------------------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
57-
| `verifier` | `String` | Yes | The name of the verifier that you have registered in Web3Auth Dashboard. |
58-
| `typeOfLogin` | `enum TypeOfLogin` | Yes | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose google, a google sign-in flow will be used. If you choose jwt, which you should be providing your own JWT token, no sign-in flow will be presented. |
59-
| `clientId` | `String` | Yes | The Client Id of the login provider. e.g. Google's Client ID |
60-
| `name` | `String` | No | Name of your verifier. |
61-
| `description` | `String` | No | Description of this login flow. |
62-
| `verifierSubIdentifier` | `String` | No | The name of the field in the JWT that should be used as the unique user ID of the JWT. Should be same as the one you used in the verifier config. |
63-
| `logoHover` | `String` | No | Logo to be shown on mouse hover. |
64-
| `logoLight` | `String` | No | Logo to be shown on light background (light theme). |
65-
| `logoDark` | `String` | No | Logo to be shown on dark background (dark theme). |
66-
| `mainOption` | `Bool` | No | Show login button on the main list |
67-
| `showOnModal` | `Bool` | No | Whether to show the login button on modal or not |
68-
| `showOnDesktop` | `Bool` | No | Whether to show the login button on desktop |
69-
| `showOnMobile` | `Bool` | No | Whether to show the login button on mobile |
70-
| `jwtParameters` | `JwtParameters` | No | Extra jwt parameters to be passed. |
55+
| Parameter | Description |
56+
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
57+
| `verifier` | The name of the verifier that you have registered on the Web3Auth Dashboard. It's a mandatory field, and accepts `string` as a value. |
58+
| `typeOfLogin` | Type of login of this verifier, this value will affect the login flow that is adapted. For example, if you choose `google`, a Google sign-in flow will be used. If you choose `jwt`, you should be providing your own JWT token, no sign-in flow will be presented. It's a mandatory field, and accepts `TypeOfLogin` as a value. |
59+
| `clientId` | Client id provided by your login provider used for custom verifier. e.g. Google's Client ID or Web3Auth's client Id if using 'jwt' as TypeOfLogin. It's a mandatory field, and accepts `string` as a value. |
60+
| `name?` | Display name for the verifier. If null, the default name is used. It accepts `string` as a value. |
61+
| `description?` | Description for the button. If provided, it renders as a full length button. else, icon button. It accepts `string` as a value. |
62+
| `verifierSubIdentifier?` | The field in JWT token which maps to verifier id. Please make sure you selected correct JWT verifier id in the developer dashboard. It accepts `string` as a value. |
63+
| `logoHover?` | Logo to be shown on mouse hover. It accepts `string` as a value. |
64+
| `logoLight?` | Light logo for dark background. It accepts `string` as a value. |
65+
| `logoDark?` | Dark logo for light background. It accepts `string` as a value. |
66+
| `mainOption?` | Show login button on the main list. It accepts `oolean` as a value. Default value is false. |
67+
| `showOnModal?` | Whether to show the login button on modal or not. Default value is true. |
68+
| `showOnDesktop?` | Whether to show the login button on desktop. Default value is true. |
69+
| `showOnMobile?` | Whether to show the login button on mobile. Default value is true. |
70+
| `jwtParameters` | Custom jwt parameters to configure the login. Useful for Auth0 configuration. It accepts `JwtParameters` as a value. |
7171

7272
</TabItem>
7373

@@ -283,14 +283,26 @@ for enabling login. The `ExtraLoginOptions` accepts the following parameters:
283283

284284
<TabItem value="table">
285285

286-
| Parameter | Type | Description |
287-
| --------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
288-
| `domain` | `string` | Your Auth0 account domain such as `example.auth0.com` or `example.mycompany.com` etc. **Use any random string in case of custom JWT login.** |
289-
| `client_id` | `string` | The Client ID found on your Auth0 Application settings page. **Use web3auth client id in case of custom JWT login.** |
290-
| `redirect_uri` | `string` | The default URL where Auth0 will redirect your browser to with the authentication result. |
291-
| `leeway` | `number` | The value in seconds used to account for clock skew in JWT expirations. |
292-
| `verifierIdField` | `string` | The field in jwt token which maps to verifier id. |
293-
| `isVerifierIdCaseSensitive` | `boolean` | Whether the verifier id field is case sensitive. Defaults to `true` |
286+
| Parameter | Description |
287+
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
288+
| `additionalParams?` | Additional params in `[key: string]` format for OAuth login, use id_token(JWT) to authenticate with web3auth. |
289+
| `domain?` | Your custom authentication domain in `string` format. For example, if you are using Auth0, it can be example.au.auth0.com. |
290+
| `client_id?` | Client id in `string` format, provided by your login provider used for custom verifier. |
291+
| `leeway?` | The value used to account for clock skew in JWT expirations. The value is in the seconds, and ideally should no more than 60 seconds or 120 seconds at max. It takes `string` as a value. |
292+
| `verifierIdField?` | The field in JWT token which maps to verifier id. Please make sure you selected correct JWT verifier id in the developer dashboard. It takes `string` as a value. |
293+
| `isVerifierIdCaseSensitive?` | `boolean` to confirm Whether the verifier id field is case sensitive or not. |
294+
| `display?` | Allows developers the configure the display of UI. It takes `string` as a value. |
295+
| `prompt?` | Prompt shown to the user during authentication process. It takes `string` as a value. |
296+
| `max_age?` | Max time allowed without reauthentication. If the last time user authenticated is greater than this value, then user must reauthenticate. It takes `string` as a value. |
297+
| `ui_locales?` | The space separated list of language tags, ordered by preference. For instance `fr-CA fr en`. |
298+
| `id_token_hint?` | It denotes the previously issued ID token. It takes `string` as a value. |
299+
| `id_token?` | JWT (ID Token) to be passed for login. |
300+
| `login_hint?` | It is used to send the user's email address during Email Passwordless login. It takes `string` as a value. |
301+
| `acr_values?` | acc_values |
302+
| `scope?` | The default scope to be used on authentication requests. The defaultScope defined in the Auth0Client is included along with this scope. It takes `string` as a value. |
303+
| `audience?` | The audience, presented as the aud claim in the access token, defines the intended consumer of the token. It takes `string` as a value. |
304+
| `connection?` | The name of the connection configured for your application. If null, it will redirect to the Auth0 Login Page and show the Login Widget. It takes `string` as a value. |
305+
| `redirect_uri?` | It can be used to specify the default url, where your custom jwt verifier can redirect your browser to with the result. If you are using Auth0, it must be whitelisted in the Allowed Callback URLs in your Auth0's application. |
294306

295307
</TabItem>
296308

0 commit comments

Comments
 (0)