UNPKG

@okta-dfuhriman/okta-auth-js

Version:

The Okta Auth SDK

github.com/okta-dfuhriman/okta-auth-js

okta-dfuhriman/okta-auth-js

143 lines (77 loc) • 3.63 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
[@okta/okta-auth-js/myaccount](../README.md) / [Exports](../modules.md) / EmailChallengeTransaction # Class: EmailChallengeTransaction ## Hierarchy - [`BaseTransaction`](BaseTransaction.md) ↳ **`EmailChallengeTransaction`** ## Table of contents ### Constructors - [constructor](EmailChallengeTransaction.md#constructor) ### Properties - [expiresAt](EmailChallengeTransaction.md#expiresat) - [headers](EmailChallengeTransaction.md#headers) - [id](EmailChallengeTransaction.md#id) - [poll](EmailChallengeTransaction.md#poll) - [profile](EmailChallengeTransaction.md#profile) - [status](EmailChallengeTransaction.md#status) - [verify](EmailChallengeTransaction.md#verify) ## Constructors ### constructor • **new EmailChallengeTransaction**(`oktaAuth`, `options`) #### Parameters | Name | Type | | :------ | :------ | | `oktaAuth` | `any` | | `options` | `any` | #### Overrides [BaseTransaction](BaseTransaction.md).[constructor](BaseTransaction.md#constructor) #### Defined in [myaccount/transactions/EmailChallengeTransaction.ts:20](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/EmailChallengeTransaction.ts#L20) ## Properties ### expiresAt • **expiresAt**: `string` #### Defined in [myaccount/transactions/EmailChallengeTransaction.ts:12](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/EmailChallengeTransaction.ts#L12) ___ ### headers • `Optional` **headers**: `Record`<`string`, `string`\> #### Inherited from [BaseTransaction](BaseTransaction.md).[headers](BaseTransaction.md#headers) #### Defined in [myaccount/transactions/Base.ts:15](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/Base.ts#L15) ___ ### id • **id**: `string` #### Defined in [myaccount/transactions/EmailChallengeTransaction.ts:11](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/EmailChallengeTransaction.ts#L11) ___ ### poll • **poll**: () => `Promise`<[`EmailStatusTransaction`](EmailStatusTransaction.md)\> #### Type declaration ▸ (): `Promise`<[`EmailStatusTransaction`](EmailStatusTransaction.md)\> ##### Returns `Promise`<[`EmailStatusTransaction`](EmailStatusTransaction.md)\> #### Defined in [myaccount/transactions/EmailChallengeTransaction.ts:16](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/EmailChallengeTransaction.ts#L16) ___ ### profile • **profile**: [`EmailProfile`](../modules.md#emailprofile) #### Defined in [myaccount/transactions/EmailChallengeTransaction.ts:13](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/EmailChallengeTransaction.ts#L13) ___ ### status • **status**: [`Status`](../enums/Status.md) #### Defined in [myaccount/transactions/EmailChallengeTransaction.ts:14](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/EmailChallengeTransaction.ts#L14) ___ ### verify • **verify**: (`payload`: [`VerificationPayload`](../modules.md#verificationpayload)) => `Promise`<[`EmailChallengeTransaction`](EmailChallengeTransaction.md)\> #### Type declaration ▸ (`payload`): `Promise`<[`EmailChallengeTransaction`](EmailChallengeTransaction.md)\> ##### Parameters | Name | Type | | :------ | :------ | | `payload` | [`VerificationPayload`](../modules.md#verificationpayload) | ##### Returns `Promise`<[`EmailChallengeTransaction`](EmailChallengeTransaction.md)\> #### Defined in [myaccount/transactions/EmailChallengeTransaction.ts:18](https://github.com/okta/okta-auth-js/blob/master/lib/myaccount/transactions/EmailChallengeTransaction.ts#L18)