PasswordTransaction.md

@okta/okta-auth-js/myaccount / Exports / PasswordTransaction

Class: PasswordTransaction

Hierarchy

• BaseTransaction

  ↳ PasswordTransaction

Table of contents

Constructors

• constructor

Properties

• created
• delete
• enroll
• get
• headers
• id
• lastUpdated
• status
• update

Constructors

constructor

• new PasswordTransaction(oktaAuth, options)

Parameters

Name	Type
oktaAuth	any
options	any

Overrides

BaseTransaction.constructor

Defined in

myaccount/transactions/PasswordTransaction.ts:16

Properties

created

• created: string

Defined in

myaccount/transactions/PasswordTransaction.ts:7

---

delete

• Optional delete: () => Promise<BaseTransaction>

Type declaration

▸ (): Promise<BaseTransaction>

Returns

Promise<BaseTransaction>

Defined in

myaccount/transactions/PasswordTransaction.ts:14

---

enroll

• Optional enroll: (payload: EnrollPasswordPayload) => Promise<PasswordTransaction>

Type declaration

▸ (payload): Promise<PasswordTransaction>

Parameters

Name	Type
payload	EnrollPasswordPayload

Returns

Promise<PasswordTransaction>

Defined in

myaccount/transactions/PasswordTransaction.ts:12

---

get

• get: () => Promise<PasswordTransaction>

Type declaration

▸ (): Promise<PasswordTransaction>

Returns

Promise<PasswordTransaction>

Defined in

myaccount/transactions/PasswordTransaction.ts:11

---

headers

• Optional headers: Record<string, string>

Inherited from

BaseTransaction.headers

Defined in

myaccount/transactions/Base.ts:15

---

id

• id: string

Defined in

myaccount/transactions/PasswordTransaction.ts:6

---

lastUpdated

• lastUpdated: string

Defined in

myaccount/transactions/PasswordTransaction.ts:8

---

status

• status: PasswordStatus

Defined in

myaccount/transactions/PasswordTransaction.ts:9

---

update

• Optional update: (payload: UpdatePasswordPayload) => Promise<PasswordTransaction>

Type declaration

▸ (payload): Promise<PasswordTransaction>

Parameters

Name	Type
payload	UpdatePasswordPayload

Returns

Promise<PasswordTransaction>

Defined in

myaccount/transactions/PasswordTransaction.ts:13