Class ForgottenCredentials

Hierarchy

ForgottenCredentials

Index

Properties

Methods

As ResetPasswordByVerificationCode RetrieveUsername SendVerificationCode

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): ForgottenCredentials
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
ForgottenCredentials.As().List() // lists ForgottenCredentials using the impersonated users' token
```
Returns ForgottenCredentials
- Defined in api/ForgottenCredentials.ts:94

ResetPasswordByVerificationCode

ResetPasswordByVerificationCode(verificationCode: string, passwordReset: PasswordReset, requestOptions?: RequestOptions): Promise<void>
Reset a password by verification code. Check out the docs for more info
Parameters
- verificationCode: string
  
  Verification code of the password reset.
- passwordReset: PasswordReset
  
  Required fields: ClientID, Username
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/ForgottenCredentials.ts:53

RetrieveUsername

RetrieveUsername(listOptions?: {
clientID?: string;
email?: string;
}, requestOptions?: RequestOptions): Promise<void>
Retrieve a username. Sends an email with username for every username associated with an email. Always returns a 200 success regardless of if email doesn’t exist in the clientID. Check out the docs for more info
Parameters
- listOptions: {
  clientID?: string;
  email?: string;
  } = {}
  - Optional clientID?: string
    
    ID of the client.
  - Optional email?: string
    
    Email of the forgotten credentials.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/ForgottenCredentials.ts:75

SendVerificationCode

SendVerificationCode(passwordResetRequest: PasswordResetRequest, requestOptions?: RequestOptions): Promise<void>
Send a verification code. Sends a temporary verification code via email, which must subsequently be passed in a Reset Password call. The verification code expires in 120 minutes. Check out the docs for more info
Parameters
- passwordResetRequest: PasswordResetRequest
  
  Required fields: ClientID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/ForgottenCredentials.ts:31

Generated using TypeDoc