Class ByProjectKeyCustomersPasswordResetRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

new ByProjectKeyCustomersPasswordResetRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeyCustomersPasswordResetRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeyCustomersPasswordResetRequestBuilder
- Defined in generated/client/reset/by-project-key-customers-password-reset-request-builder.ts:12

Properties

`Protected` `Readonly`args

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.
```
After the password is reset, any previously issued access and/or refresh tokens created through the [password flow](/authorization#password-flow) or [refresh token flow](/authorization#refresh-token-flow) are invalidated.

Resetting the password of the Customer produces the [CustomerPasswordUpdated](ctp:api:type:CustomerPasswordUpdatedMessage) Message with `reset=true`.
```
Parameters
- methodArgs: { body: CustomerResetPassword; headers?: { [key: string]: string | string[] } }
Returns ApiRequest<Customer>
- Defined in generated/client/reset/by-project-key-customers-password-reset-request-builder.ts:29