Class: default

client/apis/AuthAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• changeUserPassword
• changeUserUsername
• getAuthMetaData
• getAuthTicket
• getCredentialsVerificationStatus
• getCurrentUserPasswordStatus
• getExistingUsernames
• getMetaData
• getPasswordResetMetaData
• getRecoveryMetaData
• getRevertAccountInfo
• getSAMLMetaData
• getTwoStepVerificationMetaData
• login
• logout
• recoverUsernames
• request
• resendTwoStepVerificationCode
• resetPassword
• revertAccount
• samlAuthenticate
• sendCredentialsVerificationMessage
• sendPasswordReset
• signUp
• validatePassword
• validateUsername
• verifyPasswordReset
• verifyTwoStepCode

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/AuthAPI.ts:208

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

changeUserPassword

▸ changeUserPassword(options: ChangeUserPasswordOptions): Promise<unknown>

Parameters:

Name	Type
options	ChangeUserPasswordOptions

Returns: Promise<unknown>

Defined in: client/apis/AuthAPI.ts:390

---

changeUserUsername

▸ changeUserUsername(options: ChangeUsernameOptions): Promise<unknown>

Parameters:

Name	Type
options	ChangeUsernameOptions

Returns: Promise<unknown>

Defined in: client/apis/AuthAPI.ts:556

---

getAuthMetaData

▸ getAuthMetaData(): Promise<GetAuthMetaData>

Returns: Promise<GetAuthMetaData>

Defined in: client/apis/AuthAPI.ts:234

---

getAuthTicket

▸ getAuthTicket(): Promise<GetAuthTicket>

Returns: Promise<GetAuthTicket>

Defined in: client/apis/AuthAPI.ts:216

---

getCredentialsVerificationStatus

▸ getCredentialsVerificationStatus(options: GetCredentialsVerificationStatusOptions): Promise<GetCredentialsVerificationStatus>

Parameters:

Name	Type
options	GetCredentialsVerificationStatusOptions

Returns: Promise<GetCredentialsVerificationStatus>

Defined in: client/apis/AuthAPI.ts:270

---

getCurrentUserPasswordStatus

▸ getCurrentUserPasswordStatus(): Promise<GetCurrentPasswordStatus>

Returns: Promise<GetCurrentPasswordStatus>

Defined in: client/apis/AuthAPI.ts:310

---

getExistingUsernames

▸ getExistingUsernames(options: GetExistingUsernamesOptions): Promise<GetExistingUsernames>

Parameters:

Name	Type
options	GetExistingUsernamesOptions

Returns: Promise<GetExistingUsernames>

Defined in: client/apis/AuthAPI.ts:501

---

getMetaData

▸ getMetaData(): Promise<GetMetaData>

Returns: Promise<GetMetaData>

Defined in: client/apis/AuthAPI.ts:299

---

getPasswordResetMetaData

▸ getPasswordResetMetaData(options: GetPasswordResetMetaDataOptions): Promise<GetPasswordResetMetaData>

Parameters:

Name	Type
options	GetPasswordResetMetaDataOptions

Returns: Promise<GetPasswordResetMetaData>

Defined in: client/apis/AuthAPI.ts:321

---

getRecoveryMetaData

▸ getRecoveryMetaData(): Promise<GetRecoveryMetaData>

Returns: Promise<GetRecoveryMetaData>

Defined in: client/apis/AuthAPI.ts:403

---

getRevertAccountInfo

▸ getRevertAccountInfo(options: RevertAccountInfoOptions): Promise<RevertAccountInfo>

Parameters:

Name	Type
options	RevertAccountInfoOptions

Returns: Promise<RevertAccountInfo>

Defined in: client/apis/AuthAPI.ts:414

---

getSAMLMetaData

▸ getSAMLMetaData(): Promise<unknown>

Returns: Promise<unknown>

Defined in: client/apis/AuthAPI.ts:441

---

getTwoStepVerificationMetaData

▸ getTwoStepVerificationMetaData(): Promise<GetTwoStepVerificationMetaData>

Returns: Promise<GetTwoStepVerificationMetaData>

Defined in: client/apis/AuthAPI.ts:464

---

login

▸ login(options: LoginOptions): Promise<Login>

Parameters:

Name	Type
options	LoginOptions

Returns: Promise<Login>

Defined in: client/apis/AuthAPI.ts:245

---

logout

▸ logout(): Promise<unknown>

Returns: Promise<unknown>

Defined in: client/apis/AuthAPI.ts:258

---

recoverUsernames

▸ recoverUsernames(options: RecoverUsernamesOptions): Promise<RecoverUsernames>

Parameters:

Name	Type
options	RecoverUsernamesOptions

Returns: Promise<RecoverUsernames>

Defined in: client/apis/AuthAPI.ts:531

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

resendTwoStepVerificationCode

▸ resendTwoStepVerificationCode(options: ResendTwoStepVerificationOptions): Promise<RequestTwoStepVerification>

Parameters:

Name	Type
options	ResendTwoStepVerificationOptions

Returns: Promise<RequestTwoStepVerification>

Defined in: client/apis/AuthAPI.ts:475

---

resetPassword

▸ resetPassword(options: ResetPasswordOptions): Promise<Login>

Parameters:

Name	Type
options	ResetPasswordOptions

Returns: Promise<Login>

Defined in: client/apis/AuthAPI.ts:336

---

revertAccount

▸ revertAccount(options: RevertAccountOptions): Promise<Login>

Parameters:

Name	Type
options	RevertAccountOptions

Returns: Promise<Login>

Defined in: client/apis/AuthAPI.ts:428

---

samlAuthenticate

▸ samlAuthenticate(): Promise<unknown>

Returns: Promise<unknown>

Defined in: client/apis/AuthAPI.ts:452

---

sendCredentialsVerificationMessage

▸ sendCredentialsVerificationMessage(options: SendCredentialsVerificationMessageOptions): Promise<unknown>

Parameters:

Name	Type
options	SendCredentialsVerificationMessageOptions

Returns: Promise<unknown>

Defined in: client/apis/AuthAPI.ts:286

---

sendPasswordReset

▸ sendPasswordReset(options: SendPasswordResetOptions): Promise<SendPasswordReset>

Parameters:

Name	Type
options	SendPasswordResetOptions

Returns: Promise<SendPasswordReset>

Defined in: client/apis/AuthAPI.ts:364

---

signUp

▸ signUp(options: SignUpOptions): Promise<SignUp>

Parameters:

Name	Type
options	SignUpOptions

Returns: Promise<SignUp>

Defined in: client/apis/AuthAPI.ts:543

---

validatePassword

▸ validatePassword(options: ValidatePasswordOptions): Promise<ValidatePassword>

Parameters:

Name	Type
options	ValidatePasswordOptions

Returns: Promise<ValidatePassword>

Defined in: client/apis/AuthAPI.ts:349

---

validateUsername

▸ validateUsername(options: ValidateUsernameOptions): Promise<ValidateUsername>

Parameters:

Name	Type
options	ValidateUsernameOptions

Returns: Promise<ValidateUsername>

Defined in: client/apis/AuthAPI.ts:515

---

verifyPasswordReset

▸ verifyPasswordReset(options: VerifyPasswordResetOptions): Promise<VerifyPasswordReset>

Parameters:

Name	Type
options	VerifyPasswordResetOptions

Returns: Promise<VerifyPasswordReset>

Defined in: client/apis/AuthAPI.ts:377

---

verifyTwoStepCode

▸ verifyTwoStepCode(options: VerifyTwoStepVerificationOptions): Promise<unknown>

Parameters:

Name	Type
options	VerifyTwoStepVerificationOptions

Returns: Promise<unknown>

Defined in: client/apis/AuthAPI.ts:488