Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyCustomersPasswordResetRequestBuilder

    Index

    Constructors

    constructor

    Properties

    args

    Methods

    post

    Constructors

    Properties

    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    }

    Methods

    post

    • post(
          methodArgs: {
              body: CustomerResetPassword;
              headers?: { [key: string]: string | string[] };
          },
      ): ApiRequest<Customer>

      Use this method to reset a global Customer's password during their password reset process.

      Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.

After the password is reset, all password tokens issued previously through the [password reset flow](/../api/projects/customers#password-reset-of-customer) are invalidated. In addition, any access and refresh tokens issued previously through the [password flow](/../api/authorization#password-flow) and [refresh token flow](/../api/authorization#refresh-token-flow) are invalidated. This invalidation of tokens is [eventually consistent](/../api/general-concepts#eventual-consistency).

      Parameters

      Returns ApiRequest<Customer>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods