modules.md

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

@okta/okta-auth-js/myaccount

Table of contents

Enumerations

• EmailRole
• PasswordStatus
• Status

Classes

• BaseTransaction
• EmailChallengeTransaction
• EmailStatusTransaction
• EmailTransaction
• PasswordTransaction
• PhoneTransaction
• ProfileSchemaTransaction
• ProfileTransaction

Interfaces

• OktaAuthMyAccountInterface

Type Aliases

• AddEmailPayload
• AddPhonePayload
• ChallengePhonePayload
• EmailProfile
• EnrollPasswordPayload
• IAPIFunction
• MyAccountRequestOptions
• PhoneProfile
• UpdatePasswordPayload
• UpdateProfilePayload
• VerificationPayload

Functions

• addEmail
• addPhone
• createOktaAuthMyAccount
• deleteEmail
• deletePassword
• deletePhone
• enrollPassword
• getEmail
• getEmailChallenge
• getEmails
• getPassword
• getPhone
• getPhones
• getProfile
• getProfileSchema
• mixinMyAccount
• sendEmailChallenge
• sendPhoneChallenge
• updatePassword
• updateProfile
• verifyEmailChallenge
• verifyPhoneChallenge

Type Aliases

AddEmailPayload

Ƭ AddEmailPayload: Object

Type declaration

Name	Type
profile	{ email: string }
profile.email	string
role	EmailRole
sendEmail	boolean

Defined in

myaccount/types.ts:39

---

AddPhonePayload

Ƭ AddPhonePayload: Object

Type declaration

Name	Type
method	string
profile	{ phoneNumber: string }
profile.phoneNumber	string
sendCode	boolean

Defined in

myaccount/types.ts:53

---

ChallengePhonePayload

Ƭ ChallengePhonePayload: Object

Type declaration

Name	Type
method	string

Defined in

myaccount/types.ts:61

---

EmailProfile

Ƭ EmailProfile: Object

Type declaration

Name	Type
email	string

Defined in

myaccount/types.ts:35

---

EnrollPasswordPayload

Ƭ EnrollPasswordPayload: Object

Type declaration

Name	Type
profile	{ password: string }
profile.password	string

Defined in

myaccount/types.ts:69

---

IAPIFunction

Ƭ IAPIFunction<T>: (oktaAuth: OktaAuthOAuthInterface, options?: MyAccountRequestOptions) => Promise<T>

Type parameters

Name
T

Type declaration

▸ (oktaAuth, options?): Promise<T>

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface
options?	MyAccountRequestOptions

Returns

Promise<T>

Defined in

myaccount/types.ts:104

---

MyAccountRequestOptions

Ƭ MyAccountRequestOptions: Object

Type declaration

Name	Type
accessToken?	string
challengeId?	string
emailId?	string
id?	string
payload?	AddEmailPayload | AddPhonePayload | ChallengePhonePayload | VerificationPayload | UpdateProfilePayload

Defined in

myaccount/types.ts:92

---

PhoneProfile

Ƭ PhoneProfile: Object

Type declaration

Name	Type
profile	{ phoneNumber: string }
profile.phoneNumber	string

Defined in

myaccount/types.ts:47

---

UpdatePasswordPayload

Ƭ UpdatePasswordPayload: Object

Type declaration

Name	Type
profile	{ currentPassword?: string ; password: string }
profile.currentPassword?	string
profile.password	string

Defined in

myaccount/types.ts:75

---

UpdateProfilePayload

Ƭ UpdateProfilePayload: Object

Type declaration

Name	Type
profile	{ [property: string]: any; email?: string ; firstName?: string ; lastName?: string ; login?: string }
profile.email?	string
profile.firstName?	string
profile.lastName?	string
profile.login?	string

Defined in

myaccount/types.ts:82

---

VerificationPayload

Ƭ VerificationPayload: Object

Type declaration

Name	Type
verificationCode	string

Defined in

myaccount/types.ts:65

Functions

addEmail

▸ addEmail(oktaAuth, options?): Promise<EmailTransaction>

@scope: okta.myAccount.email.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<EmailTransaction>

Defined in

myaccount/types.ts:104

---

addPhone

▸ addPhone(oktaAuth, options?): Promise<PhoneTransaction>

@scope: okta.myAccount.phone.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<PhoneTransaction>

Defined in

myaccount/types.ts:104

---

createOktaAuthMyAccount

▸ createOktaAuthMyAccount<M, S, O, TM>(StorageManagerConstructor, OptionsConstructor, TransactionManager): OktaAuthConstructor<OktaAuthMyAccountInterface<M, S, O>>

Type parameters

Name	Type
M	extends PKCETransactionMeta<M> = PKCETransactionMeta
S	extends OAuthStorageManagerInterface<M, S> = OAuthStorageManagerInterface<M>
O	extends OktaAuthCoreOptions<O> = OktaAuthCoreOptions
TM	extends TransactionManagerInterface = TransactionManagerInterface

Parameters

Name	Type
StorageManagerConstructor	StorageManagerConstructor<S>
OptionsConstructor	OktaAuthOptionsConstructor<O>
TransactionManager	TransactionManagerConstructor<TM>

Returns

OktaAuthConstructor<OktaAuthMyAccountInterface<M, S, O>>

Defined in

myaccount/factory.ts:14

---

deleteEmail

▸ deleteEmail(oktaAuth, options?): Promise<BaseTransaction>

@scope: okta.myAccount.email.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<BaseTransaction>

Defined in

myaccount/types.ts:104

---

deletePassword

▸ deletePassword(oktaAuth, options?): Promise<BaseTransaction>

@scope: okta.myAccount.password.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<BaseTransaction>

Defined in

myaccount/types.ts:104

---

deletePhone

▸ deletePhone(oktaAuth, options?): Promise<BaseTransaction>

@scope: okta.myAccount.phone.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<BaseTransaction>

Defined in

myaccount/types.ts:104

---

enrollPassword

▸ enrollPassword(oktaAuth, options?): Promise<PasswordTransaction>

@scope: okta.myAccount.password.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<PasswordTransaction>

Defined in

myaccount/types.ts:104

---

getEmail

▸ getEmail(oktaAuth, options?): Promise<EmailTransaction>

@scope: okta.myAccount.email.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<EmailTransaction>

Defined in

myaccount/types.ts:104

---

getEmailChallenge

▸ getEmailChallenge(oktaAuth, options?): Promise<EmailChallengeTransaction>

@scope: okta.myAccount.email.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<EmailChallengeTransaction>

Defined in

myaccount/types.ts:104

---

getEmails

▸ getEmails(oktaAuth, options?): Promise<EmailTransaction[]>

@scope: okta.myAccount.email.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<EmailTransaction[]>

Defined in

myaccount/types.ts:104

---

getPassword

▸ getPassword(oktaAuth, options?): Promise<PasswordTransaction>

@scope: okta.myAccount.password.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<PasswordTransaction>

Defined in

myaccount/types.ts:104

---

getPhone

▸ getPhone(oktaAuth, options?): Promise<PhoneTransaction>

@scope: okta.myAccount.phone.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<PhoneTransaction>

Defined in

myaccount/types.ts:104

---

getPhones

▸ getPhones(oktaAuth, options?): Promise<PhoneTransaction[]>

@scope: okta.myAccount.phone.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<PhoneTransaction[]>

Defined in

myaccount/types.ts:104

---

getProfile

▸ getProfile(oktaAuth, options?): Promise<ProfileTransaction>

@scope: okta.myAccount.profile.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<ProfileTransaction>

Defined in

myaccount/types.ts:104

---

getProfileSchema

▸ getProfileSchema(oktaAuth, options?): Promise<ProfileSchemaTransaction>

@scope: okta.myAccount.profile.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<ProfileSchemaTransaction>

Defined in

myaccount/types.ts:104

---

mixinMyAccount

▸ mixinMyAccount<M, S, O, TBase>(Base): TBase & OktaAuthConstructor<OktaAuthMyAccountInterface<M, S, O>>

Type parameters

Name	Type
M	extends OAuthTransactionMeta<M> = PKCETransactionMeta
S	extends OAuthStorageManagerInterface<M, S> = OAuthStorageManagerInterface<M>
O	extends OktaAuthOAuthOptions<O> = OktaAuthOAuthOptions
TBase	extends OktaAuthConstructor<OktaAuthOAuthInterface<M, S, O, TransactionManagerInterface>, TBase> = OktaAuthConstructor<OktaAuthOAuthInterface<M, S, O, TransactionManagerInterface>>

Parameters

Name	Type
Base	TBase

Returns

TBase & OktaAuthConstructor<OktaAuthMyAccountInterface<M, S, O>>

Defined in

myaccount/mixin.ts:13

---

sendEmailChallenge

▸ sendEmailChallenge(oktaAuth, options?): Promise<EmailChallengeTransaction>

@scope: okta.myAccount.email.read

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<EmailChallengeTransaction>

Defined in

myaccount/types.ts:104

---

sendPhoneChallenge

▸ sendPhoneChallenge(oktaAuth, options?): Promise<BaseTransaction>

@scope: okta.myAccount.phone.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<BaseTransaction>

Defined in

myaccount/types.ts:104

---

updatePassword

▸ updatePassword(oktaAuth, options?): Promise<PasswordTransaction>

@scope: okta.myAccount.password.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<PasswordTransaction>

Defined in

myaccount/types.ts:104

---

updateProfile

▸ updateProfile(oktaAuth, options?): Promise<ProfileTransaction>

@scope: okta.myAccount.profile.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<ProfileTransaction>

Defined in

myaccount/types.ts:104

---

verifyEmailChallenge

▸ verifyEmailChallenge(oktaAuth, options?): Promise<BaseTransaction>

@scope: okta.myAccount.email.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<BaseTransaction>

Defined in

myaccount/types.ts:104

---

verifyPhoneChallenge

▸ verifyPhoneChallenge(oktaAuth, options?): Promise<BaseTransaction>

@scope: okta.myAccount.phone.manage

Parameters

Name	Type
oktaAuth	OktaAuthOAuthInterface<PKCETransactionMeta, OAuthStorageManagerInterface<PKCETransactionMeta>, OktaAuthOAuthOptions, TransactionManagerInterface>
options?	MyAccountRequestOptions

Returns

Promise<BaseTransaction>

Defined in

myaccount/types.ts:104