Skip to main content Link Search Menu Expand Document (external link)
ping-cli

RecoverPassword overview

Recover password command for PingOne CLI

Added in v0.0.1

Table of contents

utils

recoverPassword

Command to initiate a password recovery flow (self-service) in PingOne.

This is a self-service password recovery flow that users can initiate themselves. PingOne will send a recovery code/link to the specified email address. For administrator-initiated password resets, use the reset_password command instead.

Signature

export declare const recoverPassword: Command.Command<
  "recover_password",
  OAuthService | HttpClient | CredentialService,
  PingOneValidationError | PingOneAuthError | PingOneApiError | HttpClientError | ParseError | HttpBodyError,
  { readonly email: string; readonly environmentId: Option<string>; readonly pingoneToken: Option<Redacted<string>> }
>

Added in v0.0.1