Skip to content

Commit 1391f9d

Browse files
BcnCarlosBcnCarlos
authored
Update MfaPushList.mdx
1 parent 535c909 commit 1391f9d

File tree

1 file changed

+56
-32
lines changed

1 file changed

+56
-32
lines changed

‎main/docs/libraries/acul/js-sdk/Screens/classes/MfaPushList.mdx‎

Lines changed: 56 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22
title: "MfaPushList"
33
---
44

5-
Class implementing the mfa-push-list screen functionality
5+
The MfaPushList class implements the `mfa-push-list` screen functionality.
6+
7+
<Frame><img style={{maxHeight:"400px"}} src="/docs/images/ja-jp/cdy7uua7fh8z/6n6fftBZDpoT5FdmipebK6/3a777c3c9a87a6f6cf53cf96aab67c8d/Screenshot_2025-02-20_at_23.02.21.png" alt="MfaPushList" /></Frame>
8+
9+
## Constructors
10+
11+
Create an instance of MfaPushList screen
612

713
```ts Example
814
import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';
@@ -11,44 +17,54 @@ const mfaPushList = new MfaPushList();
1117
await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 });
1218
```
1319

14-
## Constructors
15-
16-
<ParamField body="MfaPushList" type="Constructor"/>
1720
## Properties
1821

19-
<ParamField body='branding' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}/>
20-
21-
<ParamField body='client' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}/>
22+
<ParamField body='branding' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/BrandingMembers">BrandingMembers</a></span>}>
23+
Provides branding-related configurations, such as branding theme and settings.
24+
</ParamField>
2225

23-
<ParamField body='organization' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}/>
26+
<ParamField body='client' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ClientMembers">ClientMembers</a></span>}>
27+
Provides client-related configurations, such as `id`, `name`, and `logoUrl`.
28+
</ParamField>
2429

25-
<ParamField body='prompt' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}/>
30+
<ParamField body='organization' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/OrganizationMembers">OrganizationMembers</a></span>}>
31+
Provides information about the user's organization, such as organization `id` and `name`.
32+
</ParamField>
2633

27-
<ParamField body='screen' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}/>
34+
<ParamField body='prompt' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/PromptMembers">PromptMembers</a></span>}>
35+
Contains data about the current prompt in the authentication flow.
36+
</ParamField>
2837

29-
<ParamField body='tenant' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}/>
38+
<ParamField body='screen' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/ScreenMembers">ScreenMembers</a></span>}>
39+
Contains details specific to the screen, including its configuration and context.
40+
</ParamField>
3041

31-
<ParamField body='transaction' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}/>
42+
<ParamField body='tenant' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TenantMembers">TenantMembers</a></span>}>
43+
Contains data related to the tenant, such as `id` and associated metadata.
44+
</ParamField>
3245

33-
<ParamField body='untrustedData' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}/>
46+
<ParamField body='transaction' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/TransactionMembers">TransactionMembers</a></span>}>
47+
Provides transaction-specific data, such as active identifiers and flow states.
48+
</ParamField>
3449

35-
<ParamField body='user' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}/>
50+
<ParamField body='untrustedData' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UntrustedDataMembers">UntrustedDataMembers</a></span>}>
51+
Handles untrusted data passed to the SDK, such as user input during login.
52+
</ParamField>
3653

37-
<ParamField body='screenIdentifier' type='string'/>
54+
<ParamField body='user' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/UserMembers">UserMembers</a></span>}>
55+
Details of the active user, including `username`, `email`, and `roles`.
56+
</ParamField>
3857

3958
## Methods
4059

4160
<ParamField body='getErrors' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/Error">Error</a>[]</span>}>
4261

43-
Retrieves the array of transaction errors from the context, or an empty array if none exist.
44-
45-
An array of error objects from the transaction context.
62+
This method retrieves the array of transaction errors from the context, or an empty array if none exist.
4663

4764
</ParamField>
4865

49-
<ParamField body='goBack' type='Promise<void>'>
50-
51-
Navigates back to the previous screen.
66+
<ParamField body='goBack' type='(options ?)'>
67+
This method navigates back to the previous screen.
5268

5369
```typescript Example
5470
import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';
@@ -57,19 +73,20 @@ const mfaPushList = new MfaPushList();
5773
await mfaPushList.goBack();
5874
```
5975

60-
<Expandable title="Parameters">
61-
<ParamField body='payload?' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/CustomOptions">CustomOptions</a></span>}>
62-
76+
<ParamField body="options" type="OPTIONAL">
6377
Optional custom options to include with the request.
6478

79+
<Expandable title="options properties">
80+
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"' >
81+
Any additional custom options.
6582
</ParamField>
6683

6784
</Expandable>
6885
</ParamField>
86+
</ParamField>
6987

70-
<ParamField body='selectMfaPushDevice' type='Promise<void>'>
71-
72-
Selects a registered device from the list to initiate MFA push.
88+
<ParamField body='selectMfaPushDevice' type='(options ?)'>
89+
This method selects a registered device from the list to initiate MFA push.
7390

7491
```typescript Example
7592
import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list';
@@ -78,12 +95,19 @@ const mfaPushList = new MfaPushList();
7895
await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 });
7996
```
8097

81-
<Expandable title="Parameters">
82-
<ParamField body='payload' type={<span><a href="/docs/libraries/acul/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions">SelectMfaPushDeviceOptions</a></span>}>
83-
**Properties**
98+
<ParamField body="options" type="OPTIONAL">
99+
Options for selecting an MFA push device.
100+
101+
<Expandable title="options properties">
102+
103+
<ParamField body='deviceIndex' type='number' required>
104+
The index of the device to select from the list of enrolled devices. The index is 0-based.
105+
</ParamField>
84106

85-
<ParamField body='deviceIndex' type='number'/>
107+
<ParamField body='[`key`: `string`]' type='"string" | "number" | "boolean" | "undefined"' >
108+
Any additional custom options.
86109
</ParamField>
87110

88111
</Expandable>
89-
</ParamField>
112+
</ParamField>
113+
</ParamField>

0 commit comments

Comments
 (0)