ordercloud-javascript-sdk
    Preparing search index...

    Class ForgottenCredentials

    Index
    As ResetPasswordByVerificationCode RetrieveUsername SendOneTimePassword SendVerificationCode

    • Returns this

      enables impersonation by calling the subsequent method with the stored impersonation token

      ForgottenCredentials.As().List() // lists ForgottenCredentials using the impersonated users' token

    • 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 = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns 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 } = {}
        • OptionalclientID?: string

          ID of the client.

        • Optionalemail?: string

          Email of the forgotten credentials.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    • Send an one time password Check out the docs for more info

      Parameters

      • oneTimePasswordRequest: OneTimePasswordRequest

        Required fields: ClientID

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns 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 = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalcancelToken?: CancelToken

          Axios cancelToken that can be used to cancel the request.

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods